0xmatriksh / ams-main

Attendance Management System where user checkin and checkout is done by scanning QR code.

AMS-Main

Main repository to bind ams-backend, ams-frontend and create a docker based development environment

Steps

1. Clone the repository

git clone [e-mail]:kishmatbhtr/ams-main.git

2. Create environment files

Now, Create .env file in the root path of the project. Copy the content provided in env.example

3. Get the submodules recursively

 git submodule update --init --recursive

4. Switch to the master branch and fetch the latest changes

# dir -> ams-frontend
git checkout main
git pull origin main

# dir -> ams-backend
git checkout master
git pull origin master

5. Install docker and docker compose

# installs docker
sudo apt install docker.io

# installs docker compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.28.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

# changes docker-compose permission to an executable
sudo chmod +x /usr/local/bin/docker-compose

# enable docker to be used other than superusers
sudo groupadd docker
sudo gpasswd -a $USER docker

6. Export Timeout env variables to increase timeouts

export DOCKER_CLIENT_TIMEOUT=120
export COMPOSE_HTTP_TIMEOUT=120

7. Run docker as mentioned in makefile script

make dev

8. After successful docker build completion, visit https://{YOUR_IP} for frontend, https://{YOUR_IP}/api for backend and https://{YOUR_IP}/console/ to access MinIO console (Login credentials provided in .env file)

9. To restart the running containers

make restart

10. To stop the running containers

make stop