A brief introduction of your project goes here. You may want to cover the purpose of your project, its core functionality, and what problems it solves.
Frontend | Backend | Fullstack
Frontend: https://deployed-site.whatever Backend: https://deployed-site.whatever Database: https://deployed-site.whatever
my-app/ ├─ backend/ ├─ frontend/ │ ├─ ...
Attach a very short video walkthough of all of the features [ 1 - 3 minutes ]
Attach a very short video walkthough of codebase [ 1 - 5 minutes ]
List out the key features of your application.
- Feature 1
- Feature 2
- Feature 3
List your design desissions & assumptions
Detailed instructions on how to install, configure, and get the project running. For BE/FS projects, guide the reviewer how to check mongodb schema etc.
npm install my-project
cd my-project
npm start
Provide instructions and examples on how to use your project.
# Example
Include screenshots as necessary.
Provide user credentials for autheticated pages
If your application relies on external APIs, document them and include any necessary links or references.
In case of Backend Applications provide a list of your API endpoints, methods, brief descriptions, and examples of request/response. GET /api/items - retrieve all items POST /api/items - create a new item
List and provide a brief overview of the technologies used in the project.
- Node.js
- Express.js
- MongoDB
- Other libraries/modules