https://github.com/paul1404/portalwarden
This project consists of a Node.js application and a Python script working together to read RFID tags and perform actions based on the tag data.
https://github.com/paul1404/portalwarden
javascript python raspberry-pi rfid-reader
Last synced: 3 months ago
JSON representation
This project consists of a Node.js application and a Python script working together to read RFID tags and perform actions based on the tag data.
- Host: GitHub
- URL: https://github.com/paul1404/portalwarden
- Owner: Paul1404
- License: mit
- Created: 2023-12-14T11:27:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-09T10:26:39.000Z (about 1 year ago)
- Last Synced: 2025-01-14T09:31:16.649Z (5 months ago)
- Topics: javascript, python, raspberry-pi, rfid-reader
- Language: Python
- Homepage: https://pd-portfolio.net
- Size: 3.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PortalWarden 🚪🔑
Welcome to the RPI-RFID-Door-Control repository! This guide will walk you through the steps needed to get the service up and running on your machine. 🚀
## Prerequisites 📋
Before you begin, ensure you have the following installed:
- Node.js and npm (Node Package Manager) 📦 (Version 20.11.0 Recommended)
- Docker and Docker Compose 🐳 (Install via: https://docs.docker.com/engine/install/ubuntu/#installation-methods)
## Installation and Setup 🛠️
Follow these steps to set up the project:
### 1. Clone the Repository 📂
First, clone the repository to your local machine:
```bash
git clone https://github.com/Paul1404/RPI-RFID-Door-Control.git
cd RPI-RFID-Door-Control
```
### 2. Install Node.js Dependencies 📌
Run the following command to install the necessary Node.js dependencies:
```bash
npm install
```
### 3. Install and Configure Docker 🐳
Ensure Docker and Docker Compose are installed on your system. For detailed instructions, refer to the official Docker documentation.
### 4. Run Setup Scripts 🧰
Navigate to the `tools` directory and run the main setup script:
```bash
cd tools
bash setup-main.sh
```
Follow the prompts to complete the setup. The script will handle the configuration of environment variables and other necessary setup tasks.
Next, run the database setup script:
```bash
bash setup-db.sh
```
This script sets up the database using Prisma migrations and allows you to create a new user and configure additional settings.
### 5. Start the Service 🌐
After completing the setup, start the service by running:
```bash
npm run web
```
## Accessing the Service 🖥️
Once the service is running, it will be accessible via:
```arduino
https://:3000
```
Replace `` with the IP address of the machine where the service is installed.
## Further Assistance 🆘
If you encounter any issues or have questions, please refer to the detailed documentation or open an issue in the GitHub repository.
Thank you for using RPI-RFID-Door-Control! 🎉