https://github.com/dcnick3/baam
baam: the vaporware
https://github.com/dcnick3/baam
Last synced: about 1 year ago
JSON representation
baam: the vaporware
- Host: GitHub
- URL: https://github.com/dcnick3/baam
- Owner: DCNick3
- Created: 2022-09-05T13:51:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T14:12:25.000Z (over 3 years ago)
- Last Synced: 2025-06-06T05:38:17.622Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 570 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# baam
[](https://github.com/DCNick3/baam/actions/workflows/rust-check.yml)
(🔥 blazing 🚀 fast 💿 memory 😷 safe 🦀) Best automated attendance monitoring
## Running
### Prerequisites
- Rust toolchain (stable) and `cargo` installed.
- [rustup](https://rustup.rs/) is recommended.
- native libraries for `openssl-sys` and `pq-sys` installed.
- `libssl-dev` and `libpq-dev` on Debian/Ubuntu
- `openssl-devel` and `postgresql-devel` on Fedora
- `openssl` and `postgresql` on macOS (via [brew](https://brew.sh/))
- npm, nodejs and yarn installed.
- For now, nodejs v16 is working, newer versions appear to have problems
- docker installed for running the database.
### Building
```bash
cargo build
```
### Running
Start the database:
```bash
docker run --name baam-postgres -e POSTGRES_HOST_AUTH_METHOD=trust --rm -it -p 5432:5432 postgres
```
Run the server in root directory of the repo (it's needed to find the config files):
```bash
ENVIRONMENT=dev DATABASE_URL=postgres://postgres@localhost/postgres \
cargo run
```
### Frontend development
First install the dependencies:
```bash
yarn install
```
To start the frontend development server, run:
```bash
cd frontend
yarn dev
```
Now you can access the frontend at http://localhost:5173/.
You can also run the backend in `front-dev` mode and access the frontend at http://localhost:8080/ (the backend will proxy the frontend requests):
```bash
ENVIRONMENT=front-dev DATABASE_URL=postgres://postgres@localhost/postgres \
cargo run
```
### Docker compose (development only)
Compose configuration mounts `frontend` folder to frontend container. The intention is to apply code changes in runtime.
#### Instructions
First make sure to have `npm` dependencies installed (`npm install` in `frontend` folder).
Then run
```bash
docker compose up
```
The server should be accessible on `localhost:8080`.