This is a NestJS framework based project and uses TypeORM for database operations. The project is set up with Docker for easy development and deployment. This project was developed as a part of Miazu's internal Operations and to manage stocks, orders and customer data easily.
- Clone the repository.
- Install dependencies using
yarn installornpm install. - Copy
.env.exampleto.envand update the environment variables as needed. - Run the database migrations using
npm run typeorm migration:runoryarn typeorm migration:run. - Start the development server using
npm run start:devoryarn start:dev.
After setting up the project, you can access the API endpoints as defined in the various modules in the src/ directory. Use the Swagger UI for easy interaction with the API.
This project is licensed under the terms of the MIT license.
This project wouldn't have been possible without the help of the following projects:
- NestJS: A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
- TypeORM: An ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript.
- Docker: Docker CE (Community Edition) is the strip down version of Docker EE (Enterprise Edition).
- JWT: JsonWebToken implementation for node.js.
- Swagger: Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
- awesome-nest-boilerplate: Awesome NestJS Boilerplate 😍, Typescript 💪, Postgres 🎉, TypeORM 🥳
We are grateful for their work and contributions to the open-source community.