Code Monkey home page Code Monkey logo

be-single-service's Introduction

Description

This is a single service backend for OHL LABPRO 2023. This service can be used alongside this frontend app. This service implements simple REST API for Item, Company, and User.

Author

13521044 Rachel Gabriela Chen

Initialization

  • Copy .env.example into .env and fill with your local env variables.

Installation

$ yarn install

Running the app

local

# development
$ yarn run start

# watch mode
$ yarn run start:dev

with docker

$ docker-compose up -d

Go to /api/docs to test the API or use the frontend app

Login using username: admin password: admin

image

Design Patterns

Dependency Injection (DI) Pattern

Services and other classes are defined as providers, are injected into the controllers that need them

Singleton pattern

Providers (services and controllers) are created as singleton. This pattern ensures that the state is consistent across the application, and resources are efficiently managed.

Decorator pattern

Decorators are used to mark classes as controllers, services, modules, etc., and to specify routes, middleware, guards, and other features. The decorator pattern allows for a clean and declarative way to extend and modify the behavior of components without modifying their core implementation. It is also used to add the messages to the response data.

Tech Stack

  • NodeJS v18.16.1
  • NestJS framework
  • PostgresSQL

Endpoints

image image

Bonus

B03 - Single Service Implementation (using Typescript)

B07 - Dokumentasi API

Documented with swagger (access through localhost:3000/api/docs)

be-single-service's People

Contributors

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