WorkNotes API

📄 Introduction

A secure, scalable, and well-structured RESTful API for the WorkNotes App. Built with Node.js, TypeScript, Express, and MongoDB.

WorkNotes API provides user authentication, role-based access control, and a full CRUD interface for managing work notes within teams or small organizations.

---

🛰️ Technologies Used

• Node.js: JavaScript runtime environment used to execute server-side code.
• TypeScript: Allows specifying the types of data being passed around within the code.
• Express: Fast and minimalist web framework for Node.js.
• MongoDB: Non-relational document database for agile development.
• Mongoose: ODM (Object Data Modeling) library for MongoDB and Node.js to manage data.

📋 Installation Guide

1. Clone the repository

git clone https://github.com/MartinXCVI/worknotes-api.git

2. Navigate into the project

cd worknotes-api

3. Install dependencies

npm install

4. Environment variables (.env)

Create a .env file in the root directory and configure the following variables:

NODE_ENV=development
PORT_ENV=3500
DATABASE_URI=<your_mongodb_uri>
ACCESS_TOKEN_SECRET=<your_access_token_secret>
REFRESH_TOKEN_SECRET=<your_refresh_token_secret>
CLIENT_URL=<your_client_url>

🚀 Running the Project

• Start the server in development mode (with nodemon):

npm run dev

• Production build:

npm run build
npm start

---

📚 Learn More

• Node.js latest documentation
• TypeScript documentation
• Nodemon project website
• Getting started with Express.js
• Dotenv repository
• MongoDB documentation
• Mongoose documentation
• bcrypt NPM package
• cookie-parser NPM package
• Cross Origin Resource Sharing
• JSON Web Tokens official website's introduction

---

📜 License

This project is licensed under the MIT License.

---

🧑‍💻 Developer

• MartinXCVI