gb-lux/README.md

35 lines
681 B
Markdown
Raw Permalink Normal View History

# GB-Lux
This is a prototype/draft of a light control system.
At the moment it is at database design stage.
### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Bun](https://bun.sh/)
## Installation
1. Clone the repository
2. Install dependencies
```bash
bun install
```
3. Copy `.env.example` to `.env` and fill in the values or leave them as is:
```bash
cp .env.example .env
```
4. Spin up database:
```bash
docker compose -f dev.compose.yml up
```
5. Apply database migrations:
```bash
bun db:migrate
```
6. Now you can connect to the database with your favorite client (e.g. [DBeaver](https://dbeaver.io/)) using the credentials from `.env` file.