Freeform is a text-based social media platform that aims to share and cultivate discussion around thoughts, moments, and ideas from users of all backgrounds, using text as the sole medium of communication.
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.
Make sure you have the following installed:
- Node.js (v16+ recommended)
- Java JDK 23+
- Maven 3.9.9+
- Docker (recommended)
To get a running backend, please refer to the project report to get the necessary environment variables.
Paste the information in the application.properties file located in path:
/freeform-springboot/src/main/resources
In your terminal, run the following command:
docker-compose up
Once the container is up and started, the app should be running on http://localhost:3000.
Do keep in mind that the backend is a Maven Project which may require you to install some dependencies. We recommend using the Intellij IDE as they deal with it for you.
In your IDE, run:
FreeformSpringbootApplication.java
to start up the Spring Boot server.
Open a new terminal window and cd into freeform-app to install the necesary frontend dependencies.
cd freeform-app
npm install
Once installed, start the app by running
npm start
The app should now be running on http://localhost:3000.