Skip to content

Document Repository Web Application is designed to provide a seamless platform for managing documents through CRUD (Create, Read, Update, Delete) operations using RESTful API endpoints.

Notifications You must be signed in to change notification settings

Nav0708/DocumentRepo

Repository files navigation

Document Repository Web Application README


Document Repository Web Application

This Document Repository Web Application is designed to provide a seamless platform for managing documents through CRUD (Create, Read, Update, Delete) operations using RESTful API endpoints.


Features:

  1. CRUD Operations: Allows users to perform Create, Read, Update, and Delete operations on documents stored in the repository.

  2. RESTful API: Utilizes RESTful API endpoints for seamless integration with various platforms and services.

  3. Search Functionality: Enables users to search for documents based on various criteria.


Technologies Used:

  • Backend: Node.js, Express.js
  • Database: MongoDB

Installation:

  1. Clone the Repository:

    git clone https://github.com/your-username/document-repository.git
    
  2. Navigate to the Project Directory:

    cd document-repository
    
  3. Install Dependencies:

    npm install
    
  4. Set Environment Variables:

    • Create a .env file in the root directory.
    • Define the following environment variables:
      PORT=3000
      MONGODB_URI=<Your MongoDB URI>
      JWT_SECRET=<Your JWT Secret Key>
      
  5. Start the Application:

    npm start
    

Usage:

  • CRUD Operations: Perform CRUD operations on documents using the provided API endpoints.

Contributing:

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/new-feature).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature/new-feature).
  6. Create a new Pull Request.

Author:

Navami Bhat


Acknowledgements:

  • This project was inspired by the need for a robust document repository solution.

Feel free to reach out with any questions, feedback, or suggestions! Happy documenting! 🚀

About

Document Repository Web Application is designed to provide a seamless platform for managing documents through CRUD (Create, Read, Update, Delete) operations using RESTful API endpoints.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published