- Introduction
- Features
- Project Structure
- Installation
- Usage
- Docker
- API Documentation
- Card Management
- Testing
- Version Control
- Contributing
- License
The Enhanced Digital Kanban System is a web-based application designed to manage inventory replenishment signals efficiently. It provides a visual interface for tracking the status of items across different stages of the supply chain, from full stock to empty, requiring replenishment.
- Visual Kanban Board with three-column layout (Full, In Use, Empty)
- Color-coded cards for easy status identification
- Filtering system by supplier, location, or item
- Real-time updates
- Responsive design
- Interactive cards with click-to-move functionality
- User authentication with organization-based separation
- Dedicated card management page for viewing and deleting cards
enhanced-digital-kanban/
│
├── app.py # Main Flask application
├── card_management.py # Card management blueprint
├── init_user.py # Script to initialize the database and create a test user
├── requirements.txt # Python dependencies
├── test_api.py # API tests
├── .gitignore # Git ignore file
├── Dockerfile # Docker configuration file
├── docker-compose.yml # Docker Compose configuration file
│
├── templates/
│ ├── index.html # Main Kanban board template
│ ├── login.html # Login page template
│ ├── register.html # Registration page template
│ └── manage_cards.html # Card management page template
│
└── README.md # Project documentation
- Clone the repository:
git clone https://github.com/YOUR_USERNAME/enhanced-digital-kanban.git cd enhanced-digital-kanban
-
Create a virtual environment and activate it:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate` -
Install the required packages:
pip install -r requirements.txt -
Initialize the database and create a test user:
python init_user.py
-
Start the Flask server:
python app.py -
Open a web browser and navigate to
http://localhost:5000. -
Log in with the test user credentials or register a new account.
-
Use the Kanban board to manage inventory items.
-
Access the card management page by clicking the "Manage Cards" link.
-
Build the Docker image:
docker build -t enhanced-kanban . -
Run the Docker container:
docker run -p 5000:5000 enhanced-kanban -
Access the application at
http://localhost:5000
To run the application using Docker Compose:
docker-compose up
Access the application at http://localhost:5000
The system provides a RESTful API for managing Kanban cards. For detailed endpoint information, refer to the API Documentation.
To access the card management feature:
- Log in to the system
- Click on the "Manage Cards" link
- View all Kanban cards in a tabular format
- Delete cards using the "Delete" button next to each card
Run the API tests using:
python test_api.py
This project uses Git for version control. The repository is hosted on GitHub at: https://github.com/YOUR_USERNAME/enhanced-digital-kanban
Contributions to the Enhanced Digital Kanban System are welcome. Please follow these steps:
- Fork the repository
- Create a new branch for your feature
- Commit your changes
- Push to your fork and submit a pull request
Please ensure your code adheres to the existing style and passes all tests.
This project is licensed under the MIT License. See the LICENSE file for details.