Task-Manager-Backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 🔗 Frontend Link
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Task-Manager-Backend

Task-Manager-Backend is the backend API component of the Task Manager project, allowing users to manage their tasks effortlessly and boost productivity.

🛠 Built With

Tech Stack

Backend

• Python
• Django
• Django REST framework
• SQLite

Key Features

• Server-side validations
• API endpoints

(back to top)

🚀 Live Demo

Live Demo (Not yet available)

(back to top)

🔗 Frontend Link

The Task-Manager-Frontend is built using React and is hosted on a separate repository. The frontend handles the user interface and integrates with this backend API to create and manage tasks.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need:

• A basic understanding of Git and a code editor(VS Code recommended).
• python >= 3.10.0
• Django==5.0.7
• pip

Setup

1. Install Python
2. Install Django
3. Install pip
   • Note: pip usually comes installed with Python. You can check using pip --version
4. Ensure that you have Git installed.

Install

Clone this repository

https://github.com/kessie2862/Task-Manager-Backend.git
cd Task-Manager-Backend

Set Up your Virtual Environment

pip install virtualenv
python -m venv venv

Activate the virtual environment.

# On Windows
venv\Scripts\activate

# On macOS/Linux
source venv/bin/activate

Install the required dependencies

  pip install -r requirements.txt

Apply Migrations

 python manage.py migrate

Create a Superuser (Optional)

 python manage.py createsuperuser

Usage

Run the Development Server

 python manage.py runserver

• The server will be started on localhost:8000

(back to top)

👥 Authors

👤 Prosper Kessie

• GitHub: kessie2862
• LinkedIn: Prosper Kessie

(back to top)

🔭 Future Features

• [Proper User Authorization.]
• [Implement unit tests for critical parts of the application]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, give it a ⭐.

(back to top)

🙏 Acknowledgments

Big thanks to Touch Stack Technologies for providing the project requirements.

(back to top)

📝 License

This project is MIT licensed.

(back to top)