Giter VIP home page Giter VIP logo

miazu-backend's Introduction

Miazu Internal Backend

Description

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.

Setup

  1. Clone the repository.
  2. Install dependencies using yarn install or npm install.
  3. Copy .env.example to .env and update the environment variables as needed.
  4. Run the database migrations using npm run typeorm migration:run or yarn typeorm migration:run.
  5. Start the development server using npm run start:dev or yarn start:dev.

Usage

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.

License

This project is licensed under the terms of the MIT license.

Acknowledgements

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.

miazu-backend's People

Contributors

moinul192000 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.