2026-07-06 13:16:46 +05:30
|
|
|
# Aero Resolve - Backend
|
|
|
|
|
|
|
|
|
|
This is the backend REST API powered by NestJS.
|
|
|
|
|
|
|
|
|
|
## 🚀 Getting Started
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
- Node.js (v18+)
|
2026-07-07 16:57:36 +05:30
|
|
|
- npm
|
2026-07-06 13:16:46 +05:30
|
|
|
|
|
|
|
|
### Installation
|
2026-07-07 16:57:36 +05:30
|
|
|
1. Navigate to the backend directory:
|
2026-07-06 13:16:46 +05:30
|
|
|
```bash
|
|
|
|
|
cd backend
|
|
|
|
|
```
|
2026-07-07 16:57:36 +05:30
|
|
|
2. Install the dependencies:
|
2026-07-06 13:16:46 +05:30
|
|
|
```bash
|
|
|
|
|
npm install
|
|
|
|
|
```
|
|
|
|
|
|
2026-07-07 16:57:36 +05:30
|
|
|
### Environment files
|
|
|
|
|
The project uses environment-specific files:
|
|
|
|
|
- .env
|
|
|
|
|
- .env.dev
|
|
|
|
|
- .env.test
|
|
|
|
|
|
|
|
|
|
The npm scripts automatically set NODE_ENV so the correct file is used.
|
|
|
|
|
|
|
|
|
|
### Run locally
|
|
|
|
|
Start the local development server:
|
|
|
|
|
```bash
|
|
|
|
|
npm run start
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Start the development server in watch mode:
|
2026-07-06 13:16:46 +05:30
|
|
|
```bash
|
|
|
|
|
npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
2026-07-07 16:57:36 +05:30
|
|
|
### Run tests
|
|
|
|
|
Run the test suite with the test environment:
|
2026-07-06 13:16:46 +05:30
|
|
|
```bash
|
2026-07-09 11:14:12 +05:30
|
|
|
npm run test
|
2026-07-06 13:16:46 +05:30
|
|
|
```
|
2026-07-07 16:57:36 +05:30
|
|
|
|
|
|
|
|
### Build commands
|
|
|
|
|
Build for development:
|
|
|
|
|
```bash
|
|
|
|
|
npm run build:dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Build for test:
|
|
|
|
|
```bash
|
|
|
|
|
npm run build:test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Useful scripts
|
|
|
|
|
- npm run start - starts the app using the local development environment
|
|
|
|
|
- npm run dev - starts the app using .env.dev
|
|
|
|
|
- npm test - runs tests using .env.test
|
|
|
|
|
- npm run build - builds the app for development
|
|
|
|
|
- npm run build:dev - explicit development build
|
|
|
|
|
- npm run build:test - explicit test build
|