Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kessie2862/task-manager-backend

This repo contains the backend API component of the Task Manager project, allowing users to manage their tasks effortlessly and boost productivity.
https://github.com/kessie2862/task-manager-backend

cors-headers django django-rest-framework python3

Last synced: 7 days ago
JSON representation

This repo contains the backend API component of the Task Manager project, allowing users to manage their tasks effortlessly and boost productivity.

Awesome Lists containing this project

README

        

# Task-Manager-Backend

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [🔗 Frontend Link](#frontend-link)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#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](https://github.com/kessie2862/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](https://www.python.org/)
2. [Install Django](https://www.djangoproject.com/)
3. [Install pip](https://pypi.org/project/pip/)
- Note: pip usually comes installed with Python. You can check using `pip --version`
4. Ensure that you have [Git](https://git-scm.com/) installed.

### Install

Clone this repository
```bash
https://github.com/kessie2862/Task-Manager-Backend.git
cd Task-Manager-Backend
```

Set Up your Virtual Environment

``````bash
pip install virtualenv
python -m venv venv

``````

Activate the virtual environment.

``````bash
# 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](http://127.0.0.1:8000/)

(back to top)

## 👥 Authors

👤 **Prosper Kessie**

- GitHub: [kessie2862](https://github.com/kessie2862)
- LinkedIn: [Prosper Kessie](https://www.linkedin.com/in/prosperkessie/)

(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](https://github.com/kessie2862/Task-Manager-Backend/issues).

(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](https://github.com/kessie2862/Task-Manager-Backend/blob/main/LICENSE) licensed.

(back to top)