Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yeukfei02/incidental
incident management system
https://github.com/yeukfei02/incidental
monorepo nestjs nodejs nx nx-workspace postgres prisma react typescript vite
Last synced: 3 days ago
JSON representation
incident management system
- Host: GitHub
- URL: https://github.com/yeukfei02/incidental
- Owner: yeukfei02
- License: mit
- Created: 2023-01-01T03:28:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T11:40:04.000Z (11 months ago)
- Last Synced: 2024-05-09T16:13:57.521Z (6 months ago)
- Topics: monorepo, nestjs, nodejs, nx, nx-workspace, postgres, prisma, react, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 11.9 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
incidental
incident management system
documentation:
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
- install yarn
- install node (v16+)
- install nx ()
## Testing and run
```zsh
// 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
```
```zsh
// create module
$ nx g @nrwl/nest:module
// create controller
$ nx g @nrwl/nest:controller
// create service
$ nx g @nrwl/nest:service
// 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
```
```zsh
// 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
```