The Task-Man API is a powerful and flexible API designed for task management applications. It provides a robust backend solution with essential features for managing tasks efficiently.
- Configuration Management: Utilize environment variables for easy configuration and deployment.
- Database Integration: Seamlessly interact with databases using SQLAlchemy for data persistence.
- API Routing: Organized routing with Flask Blueprints for modular and maintainable code.
- Logging Setup: Comprehensive logging for improved debugging and monitoring of application behavior.
- Testing: Ensure code reliability with pytest, featuring unit and integration tests.
- Documentation: Clear instructions for setting up and running the project.
Before you begin, ensure you have the following installed:
- Python 3.7 or higher
- pip (Python package installer)
- A compatible database (e.g., PostgreSQL, SQLite)
- Clone the repository to your local machine:
git clone https://github.com/abhiverse01/Task-Man.git
- Navigate into the project directory:
cd task-man-api - Install the required dependencies:
pip install -r requirements.txt
- Create a .env file in the root directory of the project.
- Add your environment variables, such as:
DATABASE_URL=your_database_url SECRET_KEY=your_secret_key
- To start the API server, run the following command:
flask run
- You can access the API at http://127.0.0.1:5000.
-To run the tests, execute:
pytest- This will run all the tests defined in the tests directory.
- We welcome contributions! Please follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/YourFeature).
- Make your changes and commit them (git commit -m 'Add some feature').
- Push to the branch (git push origin feature/YourFeature).
- Open a pull request.
- This project is licensed under the MIT License. See the LICENSE file for details.