Skip to content

Latest commit

 

History

History
183 lines (131 loc) · 3.75 KB

README.md

File metadata and controls

183 lines (131 loc) · 3.75 KB
Raw


incidental

incident management system

documentation: https://documenter.getpostman.com/view/3827865/2s8Z6zzX4z

features:

  • Raise an incident as an admin
  • Assign the incident to a user
  • Acknowledge the incident as a user
  • Resolve the incident as a user
  • Read details about a certain incident
  • Index incidents (includes filtering, sorting by date created/updated and incident type and paging)
  • Delete an incident

Tech Stack

  • Node.js
  • Nestjs
  • Prisma
  • Postgres
  • React
  • TailwindCSS
  • Typescript
  • Nx workspace

Requirement

Testing and run

// install node dependencies
$ yarn

// run api and web in local
$ yarn run dev

// run api in local
$ yarn run dev:api

// run web in local
$ yarn run dev:web

// production
$ yarn run start

// build dist for both api and web
$ yarn run build

// build dist only api
$ yarn run build:api

// build dist only web
$ yarn run build:web

// run test case for both api and web
$ yarn run test

// run test case only api
$ yarn run test:api

// run test case only web
$ yarn run test:web

// lint code
$ yarn run lint

// format code
$ yarn run format
// create module
$ nx g @nrwl/nest:module <module-name>

// create controller
$ nx g @nrwl/nest:controller <controller-name>

// create service
$ nx g @nrwl/nest:service <service-name>

// generate schema.prisma and prisma client
$ yarn run prisma:generate

// create migration file if schema.prisma changed
$ yarn run prisma:migrate:dev

// reset database
$ yarn run prisma:migrate:reset

// apply pending migrations in the production/staging database
$ yarn run prisma:migrate:deploy

// check migrations status in the production/staging database
$ yarn run prisma:migrate:status

// push schema.prisma state to database
$ yarn run prisma:db:push

// seed data to database
$ yarn run prisma:db:seed

// validate schema.prisma
$ yarn run prisma:validate

// format schema.prisma
$ yarn run prisma:format

// open prisma studio
$ yarn run prisma:studio
// check for un-formatted files
$ nx format:check

// overwrite un-formatted files
$ nx format:write

// check nx graph
$ nx graph

// lists installed plugins, capabilities of installed plugins and other available plugins.
$ nx list

// reports useful version numbers to copy into the Nx issue template
$ nx report

// makes sure the workspace is connected to Nx Cloud
$ nx connect-to-nx-cloud

// check more nx commands
$ nx --help