Skip to content

MinhhTien/dms-api

Repository files navigation

Document Management System

This is our project for "Wep application Document Management System" (Code subject: SWP391)

Tech Stack

Client: Vite, Material UI, Firebase, Vercel

Server: Node, Express, TypeORM, PostgreSQL, Firebase, Google Cloud Platform

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT

DB_HOST

DB_PORT

DB_USERNAME

DB_PASSWORD

DB_NAME

Run Locally

  1. Clone the project
  git clone https://github.com/DaiNghia0212/DocManagementSystemServer.git
  1. Go to the project directory
  cd DocManagementSystemServer
  1. Put into the project directory adminSDK service account file of Firebase and service account file of Google Cloud

  2. Install Cloud SQL Proxy

  curl https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.1.1/cloud-sql-proxy.x64.exe -o cloud-sql-proxy.exe
  1. Run Cloud SQL Proxy
  ./cloud-sql-proxy --credentials-file PATH_TO_GOOGLE_CLOUD_SERVICE_ACOUNT_FILE INSTANCE_CONNECTION_NAME & 
  1. Set up Environment Variables

  2. Install dependencies

  npm install
  1. Build the project
  npm run build
  1. Start the server
  • Development mode
  npm run dev
  • Production mode
  npm run start

API Reference

http://locahost:{PORT}/docs

Authors

About

Document Management System API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published