Scandy - Inventory Management System

Scandy is a lightweight and flexible inventory management system built with Flask and MongoDB. It is designed to be easily deployed using Docker and managed via Portainer.

🚀 Quick Start with Docker Compose

The easiest way to get Scandy up and running is using Docker Compose.

1. Clone the repository:

   git clone https://github.com/your-repo/scandy.git
   cd scandy

2. Create a .env file: Copy the example environment file and adjust the values:

   cp env.example .env

3. Start the application:

   docker-compose up -d

4. Access Scandy: Open your browser and navigate to http://localhost:5000.

⛴️ Installation via Portainer

To install Scandy as a Stack in Portainer:

1. Log in to your Portainer instance.
2. Go to Stacks > Add stack.
3. Give the stack a name (e.g., scandy).
4. Select Web editor and paste the content of docker-compose.yml.
5. Under Environment variables, add the necessary variables (see list below).
6. Click Deploy the stack.

⚙️ Configuration (Environment Variables)

Variable	Description	Default
APP_PORT	The port the application will be accessible on.	5000
MONGO_ROOT_USER	Root username for MongoDB.	admin
MONGO_ROOT_PASSWORD	Root password for MongoDB.	change_me_immediately
MONGODB_DB	Name of the database.	scandy
SECRET_KEY	Flask secret key for session encryption.	change_me_secret_key
FLASK_ENV	Flask environment (production or development).	production
TIMEZONE	System timezone.	Europe/Berlin
ME_PORT	Port for Mongo Express (Web UI for MongoDB).	8081
ME_BASICAUTH_USER	Basic auth username for Mongo Express.	admin
ME_BASICAUTH_PASSWORD	Basic auth password for Mongo Express.	change_me_immediately

📁 Persistent Data

Scandy uses Docker volumes to ensure your data is persistent:

• mongodb_data: Stores the MongoDB database files.
• app_uploads: Stores uploaded files.
• app_backups: Stores database backups.
• app_logs: Stores application logs.
• app_sessions: Stores user session data.

🛠️ Development

If you want to contribute to Scandy, you can use the following commands:

• make build: Build the Docker images.
• make test: Run the test suite.
• make lint: Run linting checks.
• make format: Format the code.

📄 License

This project is licensed under the MIT License.