NoteNest provide API endpoints for you to manage and share your notes with others. Users can Create, Read, Update, Delete, Search amd Share the notes. Each user will be Rate Limited at the rate of 100 Req / Hour for higher throughput.
- TypeScript - Language ( TypeScript for strict type checking )
- Prisma - ORM ( Prisma makes it easier while migrating the DB )
- PostgreSQL - Database ( PostgreSQL offers robust relational data modeling, ideal for structured data )
- Zod - Input Validation ( Zod validates the appropriate input schema and Error Handling )
- Expressjs - Framework ( Minimalist Nodejs backend framework )
yarn has been used as the package manager
- Clone the project
git clone https://github.com/VK-RED/NoteNest - Move to the root folder
cd NoteNest - Setup Environment Variables
cp .env.example .envand set yourDATABASE_URLin.envfile - Install the required dependencies
yarn install - Apply prisma migrations
npx prisma migrate dev - Now run
yarn devto start the application
Now visit http://localhost:3000. You can see the app running.
You can run the script yarn studio to visualize the database and it opens http://localhost:5555
If you feel any new feature (or) something is not working, feel free to raise an issue !
Thank you for your support !!!