README
Open Source Issue Tracker
A lightweight, self-hosted issue tracking system built with Python and SQLite. Ideal for small teams or individual developers managing open-source projects.
๐ Features
- Issue Management: Create, update, and delete issues with ease.
- SQLite Backend: Stores data locally in a lightweight SQLite database.
- Web Interface: Simple and intuitive web UI for managing issues.
- Minimal Dependencies: Built with Python and minimal external libraries.
๐ ๏ธ Installation
Prerequisites
- Python 3.8+
- pip (Python package installer)
Steps
-
Clone the Repository
git clone https://github.com/rudrasheth/opensource-issue-tracker.git cd opensource-issue-tracker -
Set Up a Virtual Environment
python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate` -
Install Dependencies
pip install -r requirements.txt -
Run the Application
python app.pyThe application will start on
http://127.0.0.1:5000.
๐ Project Structure
opensource-issue-tracker/
โโโ app.py # Main application file
โโโ database.py # Database setup and models
โโโ issues.db # SQLite database file
โโโ requirements.txt # Python dependencies
โโโ templates/ # HTML templates for the web interface
๐งช Testing
To run tests, ensure you have the required dependencies installed and then execute:
pytest
๐ค Contributing
We welcome contributions! To get started:
- Fork the repository.
- Create a new branch (
git checkout -b feature-name). - Make your changes.
- Commit your changes (
git commit -am 'Add new feature'). - Push to the branch (
git push origin feature-name). - Create a new Pull Request.
Please ensure your code adheres to the existing style and includes appropriate tests.
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to customize this template further based on any additional features or specifics of your project.