Skip to content

Latest commit

 

History

History
142 lines (120 loc) · 3.2 KB

README.md

File metadata and controls

142 lines (120 loc) · 3.2 KB
Raw

Simple CRUD back-end APP

I created this app in order to demonstrate the Clean Architecture / SOLID principles (from my point of view) using the following dependencies:

Folder Structure

┣ src/
┃ ┣ app/
┃ ┃ ┣ controller/
┃ ┃ ┃ ┣ activity/
┃ ┃ ┃ ┣ user/
┃ ┃ ┃ ┣ controller.ts
┃ ┃ ┃ ┗ genericController.ts
┃ ┃ ┗ util/
┃ ┃   ┣ httpHelper.ts
┃ ┃   ┗ httpResponse.ts
┃ ┣ db/
┃ ┃ ┣ dbRepository.ts
┃ ┃ ┗ pgRepository.ts
┃ ┣ domain/
┃ ┃ ┣ entities/
┃ ┃ ┃ ┣ abstractBaseEntity.ts
┃ ┃ ┃ ┣ activity.ts
┃ ┃ ┃ ┣ index.ts
┃ ┃ ┃ ┗ user.ts
┃ ┃ ┗ usecases/
┃ ┃   ┣ createUseCase.ts
┃ ┃   ┣ deleteUseCase.ts
┃ ┃   ┣ getUseCase.ts
┃ ┃   ┣ index.ts
┃ ┃   ┣ updateUseCase.ts
┃ ┃   ┣ usecase.ts
┃ ┃   ┗ viewUseCase.ts
┃ ┣ main/
┃ ┃ ┣ adapters/
┃ ┃ ┃ ┗ routeAdapter.ts
┃ ┃ ┣ config/
┃ ┃ ┃ ┣ mikro-orm.pg.ts
┃ ┃ ┃ ┣ moduleAlias.ts
┃ ┃ ┃ ┣ orm-config.ts
┃ ┃ ┃ ┗ setupRoutes.ts
┃ ┃ ┣ factories/
┃ ┃ ┃ ┣ controller/
┃ ┃ ┃ ┣ db/
┃ ┃ ┃ ┗ useCases/
┃ ┃ ┗ routes/
┃ ┃   ┣ activityRoute.ts
┃ ┃   ┗ userRoute.ts
┃ ┗ server.ts
┣ .env
┣ .gitignore
┣ docker-compose.yml
┣ package-lock.json
┣ package.json
┣ README.md
┗ tsconfig.json

Usage

  1. git clone https://github.com/thomascouto/backend-crud-app.git
  2. docker-compose up -d (adjust docker yml file on your needs if you want) 3.0 Local Use: npx mikro-orm migration:create --initial 3.1 Heroku Use: After deployment run the following: heroku run "npx mikro-orm schema:create -r --fk-checks" (I could not make 3.0 work on heroku because of session_replication_role variable).
  3. npm run dev (local dev mode)

Available routes / entities

Activities entity:

/api/activity (get) /api/activity/update/:id (put)

{
  //update request
  "name": "My activity",
  "userid": "35"
}

/api/activity/delete/:id (delete) /api/activity/create (post)

{
  // create request
  "name": "My activity",
  "userid": "35"
}

/api/activity/view

Users entity

/api/user /api/user/update/:id /api/user/delete/:id /api/user/create

{
  "username": "username",
  "password": "password"
}

UML diagrams

This is the basic sequence flow (I'm not a UML expert at all...)

sequenceDiagram
participant A as RestClient
participant B as Express Router
participant C as Controller
participant D as UseCase
participant E as DataBase<br>Repository
A ->> B: [get] /api/user
B ->> C: routeAdapter <br> Controller
C ->> D: useCase <br> perform(request)
D ->> E: perform <br> request
E -->> C: Promise<Entity>
C -->> A: JSON response
Loading

Next releases

The next planned release will be the front-end app consuming this api using React.