csu33012-2526-project24

Backend Setup

1. Clone Repository
2. cd into notes folder
3. run mvn clean install
4. run mvn spring-boot:run
5. Now the backend hould be running on port 8080, and you can use curl or postman to interact with it

Database

NOTE: Currently the backend is hosted using MongoDB Atlas. I have tested this on my local machine and it works fine, however Coder cannot access the Mongo endpoint (some kind of DNS restriction), and as there is no local Mongo instance ready yet our database will NOT function inside of coder. However, once that problem is resolved, we can simply plug in the working Mongo URI and the code will work.

Currently, I have set up SpringBoot to use a test account on my (luanders@tcd.ie) cloud hosted MongoDB Cluster. To set up your own MongoDB Atlas account:

1. Create a (free-tier) account here: https://www.mongodb.com/cloud/atlas/register
2. Create a new database cluster, name it.
3. Create a new user for the database and set it as an admin role. Save the name and password for later.
4. Click on the connect button in your cluster, then click on drivers, and grab the Java access URI.
5. Create a new .env file
6. Set the URI as the following environmental variable: MONGODB_URI so that your database can be accessed while coding, making sure to use the name and password you created earlier. For example: mongodb+srv://<username>:<password>@cluster_name.abcde.mongodb.net/notes?retryWrites=true&w=majority.
7. Set the name of the Cluster to the follow environment variable: MONGODB_NAME
8. Change the application.properties file to match the newly create environment variables (i.e spring.data.mongodb.uri=$MONGODB_URI)
9. Run the command source .env to load environment variables
10. MongoDB should now be connected!

Frontend

To run the frontend:

1. cd into frontend
2. run npm run dev
3. React is not running on port 3000