An open API service indexing awesome lists of open source software.

https://github.com/marcus-rise/budget-api

Backend service
https://github.com/marcus-rise/budget-api

docker nestjs nodejs typescript

Last synced: about 1 year ago
JSON representation

Backend service

Awesome Lists containing this project

README

          

# Budget API

Backend service for https://github.com/Marcus-Rise/budget

## Requirements

- `yarn`

## Preparation

- Copy `.env.example` as `.env`

## Local dev

In project root folder

- Up services
```shell
docker-compose -f docker-compose.local.yml up -d
```

- Watch `http://localhost:8080` db browser

In `app` folder

- Install dependencies
```shell
yarn install
```

- Copy `.env.example` as `.env`

- Generate orm config
```shell
yarn typeorm:config
```

- Run migrations
```shell
yarn migration:run
```

- Run local dev server
```shell
yarn start:dev
```

## Local demo

In `app` folder

- Install dependencies
```shell
yarn install
```

- Build app
```shell
yarn build
```

- In project root folder Up
```shell
docker-compose -f docker-compose.demo.yml up -d
```

- Watch `https://localhost` app
- Watch `https://localhost/adminer` db browser

**Basic auth:** (https://caddyserver.com/docs/v2-upgrade#basicauth)

- User: user
- Password: password