Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.01 KB

README.md

File metadata and controls

52 lines (39 loc) · 2.01 KB
Raw

🩺 Valorant

A medical logistics app that assists family doctos manage their practices

📘 Directory Breakdown

├── api-gateway: API gateway src
├── ci-pipeline: Jenkins pipeline (can be deployed locally, will require configuration)
│   ├── ci-pipeline-data: Jenkins container data
│   └── jenkins: Jenkins docker deployment src
├── frontend: React frontend src
└── services: All app microservices (all follow same structure)
    ├── app: Microservice src
    │   ├── __tests__: All service tests
    │   │   ├── e2e: E2E tests
    │   │   ├── integration: Integration tests
    │   │   └── unit: Unit tests
    │   └── src: Microservice app src
    ├── bookings
    ├── medical-conditions
    └── patient-record

🔨 Installation

Development Environment

  1. Run ./setup-dev-environment.sh to install development environment prerequisites

Microservices

  1. cd into microservice directory
  2. Run npm i in service directory to install all dependencies
  3. Run npm start:dev to start microservice in development mode

⚙️ NPM Tasks

Usage: npm run <task_name>

  • start - Runs the microservice in PRODUCTION mode
  • start:dev - Runs microservice in DEVELOPMENT mode (including autorefreshing on code change)
  • test:all - Runs all microservices tests (i.e. integration, unit, e2e)
  • test:unit - Runs all microservice unit tests
  • eslint - Checks code for consistent styling, documentation, and security holes
  • eslint:fix - Attempts to fix code styling, documentation, and security. Commonly requires developer intervention

🏎 Running a Service Locally

  1. Build the service image → docker build -t <SERVICE_NAME>-web .
  2. Start service defined in docker-compose.yml file → docker-compose up →
  3. Viewing the DB in the postgres container → psql -h <DB_HOST> -p <DB_PORT | 5432> -U <DB_USERNAME> -d <DB_NAME>