Document Control Management System (Service)

A service for a web application that helps in managing documents in the industrial business such as quality control, product manufacturing, creating purchasement request, maintenance scheduling, etc.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This project is created under the graduation project of the KMUTT University that would be then served for the industrial company (This is not the final prototype just an outline for implementing the next version)

Built With

• NestJs
• PostgreSQL

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to get this project works you need to have

• Nodejs
• PostgreSQL

Installation

1. Clone the repo

   git clone https://github.com/Prisma-Laster-Management-Tools/document-control-management-system-service-v1.git

2. Install NPM packages

   npm install

Usage

1. Start the NestJs server by

   npm start:dev

   and the service will run on port 3000 (editable)

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL License. See LICENSE for more information.

Contact

Thiti Mahawannakit - @Thiti-Dev
Tanawatt Jituthai - @sspritesatang

Acknowledgements

• Roles system is planned to be fully functionable in the v2 prototype
• Some error cases are not well implemented due to the time limit [you may found some swinky peaky tings]
• Feel free to leave any issues or implementation idea in the issues tab