Skip to content

README.md

Latest commit

 

History

History
283 lines (226 loc) · 7.38 KB

README.md

File metadata and controls

283 lines (226 loc) · 7.38 KB

CRUD Notes API

A robust and secure RESTful API for managing notes with user authentication, built with Node.js, Express, and MongoDB.

🚀 Features

  • User Authentication: Secure registration and login with JWT tokens
  • CRUD Operations: Create, read, update, and delete notes
  • User Isolation: Users can only access their own notes
  • Input Validation: Comprehensive validation and sanitization
  • Error Handling: Robust error handling with meaningful messages
  • Security: Password hashing, secure cookies, and protection against common vulnerabilities
  • Testing: Comprehensive test suite with 106+ tests and 90%+ coverage
  • Docker Support: Full containerization with development and production environments

� Quick Start with Docker

Prerequisites

  • Docker Engine 20.10+
  • Docker Compose 2.0+

Production Deployment

# Clone the repository
git clone https://github.com/AakashSuresh2003/CRUD_Notes_API.git
cd CRUD_Notes_API

# Set up environment
cp .env.example .env
# Edit .env with your production values

# Start the application
./docker-run.sh start

# Check status
./docker-run.sh status

Development Environment

# Start development environment with hot reload
./docker-run.sh start dev

# Run tests
./docker-run.sh test dev

# View logs
./docker-run.sh logs

Manual Docker Commands

# Build and run production
docker compose up -d

# Build and run development
docker compose -f docker-compose.dev.yml up -d

# Stop services
docker compose down

For complete Docker documentation, see DOCKER.md

📦 Installation

  1. Clone the repository:

    git clone https://github.com/AakashSuresh2003/CRUD_Notes_API.git
cd CRUD_Notes_API

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env file in the root directory:

    MONGODB_URI=mongodb://localhost:27017/crud_notes_db
JWT_SECRET=your_super_secret_jwt_key_change_this_in_production
JWT_EXPIRES_IN=7d
PORT=3000

  4. Start the development server:

    npm run start:dev

    Or start the production server:

    npm start

🧪 Testing

This project includes a comprehensive test suite with 81+ tests covering all functionality.

Run All Tests

npm test

Run Unit Tests Only

npm run test:unit

Run Integration Tests Only

npm run test:integration

Run Tests with Coverage

npm run test:coverage

Run Tests in Watch Mode

npm run test:watch

Test Coverage

  • Models: Data validation and database operations
  • Controllers: Business logic and error handling
  • Middleware: Authentication and authorization
  • Routes: API endpoint functionality
  • Validation: Input sanitization and validation
  • Database: Connection and error handling
  • Security: JWT tokens, password hashing, user isolation

For detailed test documentation, see TEST_DOCUMENTATION.md.

🔌 API Endpoints

Authentication Routes (/api/user)

Method Endpoint Description Auth Required
POST /api/user/register Register a new user No
POST /api/user/login Log in and obtain authentication token No
GET /api/user/logout Log out and clear authentication token No
GET /api/user/refetch Fetch user data using valid token Yes

Notes Routes (/api/v1/notes)

Method Endpoint Description Auth Required
GET /api/v1/notes Get all notes for authenticated user Yes
GET /api/v1/notes/:id Get specific note by ID Yes
POST /api/v1/notes Create a new note Yes
PUT /api/v1/notes/:id Update note by ID Yes
DELETE /api/v1/notes/:id Delete note by ID Yes

📖 Usage Examples

1. Register a New User

curl -X POST http://localhost:3000/api/user/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "fullName": "John Doe",
    "email": "john@example.com",
    "password": "securepassword123"
  }'

2. Login

curl -X POST http://localhost:3000/api/user/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "password": "securepassword123"
  }'

3. Create a Note

curl -X POST http://localhost:3000/api/v1/notes \
  -H "Content-Type: application/json" \
  -H "Cookie: token=your_jwt_token_here" \
  -d '{
    "title": "My First Note",
    "description": "This is the content of my first note"
  }'

4. Get All Notes

curl -X GET http://localhost:3000/api/v1/notes \
  -H "Cookie: token=your_jwt_token_here"

🔒 Security Features

  • Password Hashing: All passwords are hashed using bcrypt
  • JWT Authentication: Secure token-based authentication
  • User Isolation: Users can only access their own notes
  • Input Validation: All inputs are validated and sanitized
  • Secure Cookies: HTTP-only, secure, and SameSite cookie configuration
  • Error Handling: Sensitive information is never exposed in error messages

🚀 Production Deployment

  1. Set environment variables:

    NODE_ENV=production
MONGODB_URI=your_production_mongodb_uri
JWT_SECRET=your_super_secure_production_secret
JWT_EXPIRES_IN=7d
PORT=3000

  2. Install dependencies:

    npm ci --only=production

  3. Start the application:

    npm start

🏗️ Project Structure

CRUD_Notes_API/
├── src/
│   ├── controller/          # Route controllers
│   │   ├── auth.controller.js
│   │   └── notes.controller.js
│   ├── DataBase/           # Database configuration
│   │   └── db.js
│   ├── middleware/         # Custom middleware
│   │   └── authMiddleware.js
│   ├── models/            # Mongoose models
│   │   ├── user.models.js
│   │   └── notes.models.js
│   ├── router/            # Route definitions
│   │   ├── auth.router.js
│   │   └── notes.router.js
│   └── validation/        # Input validation schemas
│       └── post.validation.js
├── tests/                 # Test suite
│   ├── unit/             # Unit tests
│   ├── integration/      # Integration tests
│   └── utils/            # Test utilities
├── .github/workflows/    # CI/CD configuration
├── index.js              # Application entry point
├── jest.config.js        # Jest configuration
├── package.json          # Dependencies and scripts
└── README.md             # This file

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (npm test)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

📝 License

This project is licensed under the ISC License.

🙏 Acknowledgments

  • Express.js community for the excellent web framework
  • MongoDB team for the robust database solution
  • Jest team for the comprehensive testing framework
  • All contributors and supporters of this project

Built with ❤️ by AakashSuresh2003