Giter VIP home page Giter VIP logo

baam's Introduction

baam

Rustfmt

(๐Ÿ”ฅ blazing ๐Ÿš€ fast ๐Ÿ’ฟ memory ๐Ÿ˜ท safe ๐Ÿฆ€) Best automated attendance monitoring

Running

Prerequisites

  • Rust toolchain (stable) and cargo installed.
  • 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)
  • npm, nodejs and yarn installed.
    • For now, nodejs v16 is working, newer versions appear to have problems
  • docker installed for running the database.

Building

cargo build

Running

Start the database:

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):

ENVIRONMENT=dev DATABASE_URL=postgres://postgres@localhost/postgres \
  cargo run

Frontend development

First install the dependencies:

yarn install

To start the frontend development server, run:

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):

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

docker compose up

The server should be accessible on localhost:8080.

baam's People

Contributors

bragov4ik avatar chermnyx avatar dcnick3 avatar hismaj3sty avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.