https://github.com/chainside/brie-backend

https://github.com/chainside/brie-backend

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/chainside/brie-backend
• Owner: chainside
• Created: 2023-11-14T13:51:10.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-14T14:00:21.000Z (about 1 year ago)
• Last Synced: 2023-11-24T17:29:08.661Z (about 1 year ago)
• Language: TypeScript
• Size: 169 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# RUN the project locally

Run this script: run_project_local.sh, it should run the docker compose and seed data into postgres container.

Check that you have the correct folder structure before running, example: 

brie:.

     ├── brie-backend:.

     |                └──run_project_local.sh

     └── brie-frontend

# Brie Backend Swagger UI

    - http://localhost:8080/docs

  

# Brie Frontend UI

    - http://localhost

  

# NPM commands

```sh

# Start the application using the transpiled NodeJS

npm run start

# Run the application using "ts-node"

npm run dev

# Transpile the TypeScript files

npm run build

# Internal command used during the Docker build stage

npm run build:docker

# Run the project' functional tests

npm run test

# Lint the project files using ESLint

npm run lint

# Create a new migration named MyMigration

npm run migration:create [MyMigration]

# Run the TypeORM migrations

npm run migration:run

# Revert the TypeORM migrations

npm run migration:revert

```