47 lines (37 loc) · 1.09 KB

📝 Notes API

A REST API for note management built with Node.js, Express, PostgreSQL and JWT Authentication.

🌐 Live: https://notes-api-production-1d42.up.railway.app

🛠️ Technologies

Node.js
Express.js
PostgreSQL
JWT Authentication
Bcrypt

🚀 Routes

Auth

POST /auth/register → Create an account
POST /auth/login → Login and get a token

Notes (🔒 require JWT token)

GET /notes → Get all your notes
POST /notes → Create a note
PUT /notes/:id → Update a note
DELETE /notes/:id → Delete a note

🧪 Testing

You can test the API using Postman.

Register an account → POST /auth/register
Login to get your token → POST /auth/login
Use the token in the authorization header for all notes routes

⚙️ Installation

Clone the repository
Run npm install
Create a .env file with your database credentials
Run node server.js

🔑 Environment Variables

DB_HOST=localhost
DB_USER=postgres
DB_PASSWORD=yourpassword
DB_NAME=notes
DB_PORT=5432
JWT_SECRET=yoursecret