The Node.js backend for the Noteworthy app.
- Node.js
- Express.js
- TypeScript
- Jest (ts-jest)
- DotEnv
- Helmet.js
- Bcrypt
- Cors
- Mysql2
- Docker
- Docker Compose
| Endpoint | Method | Description | Request Body |
|---|---|---|---|
| /auth/register | POST | Registers a new user. | JSON containing email and password. |
| /auth/login | POST | Logs in an existing user. | JSON containing email and password. |
| /notes/new | POST | Creates a new note for the authenticated user. | JSON containing note details. |
| /notes/all | GET | Fetches all notes of a user. | N/A - User ID as query parameter. |
| /notes/update | PUT | Updates a specific note by ID for the authenticated user. | JSON containing updated note details. |
| notes/delete | DELETE | Deletes a specific note by ID for the authenticated user. | N/A - Note ID as query parameter. |
- Ensure Docker is installed and running.
- Build a Docker image of the MySQL container based on the
DockerFileinbackend-db-docker/. - While running the image ensure that port
3306is forwarded using the flag-p 3306:3306and also set the environment variableMYSQL_ALLOW_EMPTY_PASSWORDto true using the following flag-e MYSQL_ALLOW_EMPTY_PASSWORD=truewhile running a container based on the image. the container
- Ensure that the database container is already running.
- Build and run a Docker container based on the
DockerFileat the root of the project ensuring that the port3001is forwarded using the flag-p 3301:3301. - The server will be running on http://localhost:3001.
- Go to the root directory of the project where the
docker-compose.yamlfile is located. - Run the following command
docker-compose upfrom the terminal. - The server will be running on http://localhost:3001 and the database will be running on http://localhost:3306.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent