https://github.com/pymarcus/securegate
Secure Gate is a complete access management solution, combining a user-friendly web app, a robust backend system, and ESP32 integration. It enables users to manage gate access by RFID cards, providing better security and convenience.
https://github.com/pymarcus/securegate
distributed-systems mqtt postgresql python3 reactjs rpc
Last synced: 28 days ago
JSON representation
Secure Gate is a complete access management solution, combining a user-friendly web app, a robust backend system, and ESP32 integration. It enables users to manage gate access by RFID cards, providing better security and convenience.
- Host: GitHub
- URL: https://github.com/pymarcus/securegate
- Owner: PyMarcus
- License: mit
- Created: 2023-10-19T02:33:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-12T23:23:00.000Z (about 2 years ago)
- Last Synced: 2023-11-13T01:27:32.069Z (about 2 years ago)
- Topics: distributed-systems, mqtt, postgresql, python3, reactjs, rpc
- Language: TypeScript
- Homepage:
- Size: 2.03 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secure Gate
Secure Gate is a complete access management solution, combining a user-friendly web app, a robust backend system, and ESP32 integration.
It enables users to manage gate access by RFID cards, providing better security and convenience.
## Requirements
- Python 3.10
- Pip 21.3
- Virtualenv
- Pre-commit
- Docker
- Docker Compose
## Setup
To setup the project, you can just run the `setup.sh` script.
1. Make the script executable
```bash
chmod +x ./scripts/setup.sh
```
2. Run the script
```bash
./scripts/setup.sh
```
## Manual Setup
1. Create a virtual environment
```bash
python3 -m venv .venv
```
2. Activate the virtual environment
```bash
source .venv/bin/activate
```
3. Install python dependencies
```bash
pip install -r requirements.txt
```
4. Install the pre-commit hooks
```bash
pre-commit install
```
5. Install node dependencies
```bash
npm install
```
6. Make husky pre-commit hook executable
```bash
chmod +x .husky/pre-commit
```
7. Create `.env` file
```bash
cp .env.example .env
```
## Running
1. Run docker-compose
```bash
docker-compose up
```
## Authors
- [@pymarcus](https://github.com/PyMarcus)
- [@eoisaac](https://github.com/eoisaac)