AuthCRUDFileManager

AuthCRUDFileManager is a Node.js-based API solution for secure authentication, CRUD operations, and file management. This API leverages modern security practices to offer a robust backend suitable for various applications requiring user management and file storage capabilities.

Features

• JWT Authentication: Implementing JSON Web Tokens (JWT) for secure authentication and session management.
• User CRUD Operations: Full suite of CRUD operations for comprehensive user management.
• File Handling: Secure uploading, storage, and management of files.
• Data Validation: Ensuring data integrity and correctness with input validation.
• Error Handling: Graceful error responses via middleware for improved API resilience.
• API Documentation: Utilizing Swagger for clear and structured API endpoint documentation.
• Rate Limiting: Protection against brute-force attacks with rate limit controls on user authentication routes.
• Security Practices: Applying secure HTTP headers with Helmet to protect against common web vulnerabilities.
• Performance: Employing compression to decrease response times through reduced payload size.
• Logging: Utilizing morgan to log HTTP requests for auditing and debugging.
• CORS Management: Configurable middleware for handling Cross-Origin Resource Sharing (CORS).
• MongoDB Integration: Leveraging MongoDB for robust data storage and retrieval capabilities.
• Static Files: Serving static files like uploads from a dedicated directory.
• Swagger UI: Interactive, user-friendly API documentation accessible via Swagger UI.
• Environment Variable Configurations: Safely managing configurations and secrets with a .env file.

Folder Structure

Below is an outline of the important files and folders included in the AuthCRUDFileManager project:

/AuthCRUDFileManager
|-- /node_modules
|-- src
    |-- /config
        |-- config.js
        |-- swagger.js
    |-- /controllers
        |-- authController.js
        |-- userController.js
        |-- fileController.js
        |-- validation.js
    |-- /middleware
        |-- authMiddleware.js
        |-- errorHandler.js
        |-- fileUploadMiddleware.js
    |-- /models
        |-- userModel.js
        |-- taskModel.js
    |-- /routes
        |-- authRoutes.js
        |-- userRoutes.js
        |-- fileRoutes.js
|-- /uploads
|-- /postman
        |--AuthCRUDFileManager.json
|-- server.js
|-- .gitignore
|-- .env
|-- README.md
|-- package-loack.json
|-- package.json

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

node.js
npm
A MongoDB database

Installation

A step-by-step series of examples that tell you how to get a development environment running:

1. Clone the repository:

   git clone https://github.com/sarathk73/AuthCRUDFileManager.git
   cd AuthCRUDFileManager

Install the necessary node modules:

  npm install

Configuration

Configure your environment variables appropriately:

1.Create a .env file in the root directory and add the following

DB_CONNECTION=mongodb+srv://your-db-connection-string
JWT_SECRET=your-secret
# JWT secret for signing tokens
JWT_SECRET=your-secret

# Refresh token secret for signing refresh tokens
REFRESH_TOKEN_SECRET=your-secret

PORT=3001

Start the server:

npm start or node server.js

The server will start on port 3001 or the next available port.

Postman

You can find the Postman collection in /postman directory to easily test the API endpoints.

API Documentation

The API documentation is provided via Swagger, which outlines all the routes, possible parameters, and responses. Access the interactive documentation at:

http://localhost:3001/api-docs

Replace http://localhost:3001 with your production URL if applicable

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Sarath K - Initial work - sarathk73

License

This project is licensed under the MIT License - see the LICENSE file for details.