Code Monkey home page Code Monkey logo

document-management-system's Introduction

Document Management System

A robust system built for efficient management of documents using state-of-the-art technologies.

Tech Stack

  • gRPC: A high-performance, open-source, and universal RPC framework.
  • Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
  • MongoDB: A document-based, distributed database built for modern application developers.
  • Swagger/OpenAPI: A framework for API specification and a set of tools for auto-generating API documentation.
  • Docker: A platform used to develop, ship, and run applications inside containers.

Getting Started

Prerequisites

  • Ensure you have Docker installed on your machine.
  • Node.js and npm installed.

Clone the Repository

git clone https://github.com/kartikmanimuthu/document-management-system.git
cd document-management-system

Build and Deploy with Docker

  1. Navigate to the project root and build the Docker image:
docker build -t document-management-system .
  1. Use Docker Compose to orchestrate the deployment:
docker-compose up -d

Access the Swagger/OpenAPI Documentation

Once the services are up and running, the API documentation can be accessed at:

http://localhost:8000/api-docs

Usage

  1. Creating a Document: Make a gRPC call to the appropriate endpoint with the document details.
  2. Fetching a Document: Use the provided document ID to fetch the details.
  3. ... (Continue with other system features)

Contributing

Contributions are welcome! Please read our contribution guide for more details.

License

This project is licensed under the MIT License. See LICENSE.md for details.

Acknowledgements

  • The team and contributors who have put efforts into building this robust system.
  • The open-source community for the tools and libraries.

For further questions or feedback, please raise an issue in the repository or contact the maintainers.

document-management-system's People

Contributors

kartikmanimuthu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.