https://github.com/lftobs/task-manager
Task-manager is an API built using fastapi, postgresql, rocketry and hosted on render.
https://github.com/lftobs/task-manager
fastapi python rocketry todoapi
Last synced: 15 days ago
JSON representation
Task-manager is an API built using fastapi, postgresql, rocketry and hosted on render.
- Host: GitHub
- URL: https://github.com/lftobs/task-manager
- Owner: Lftobs
- Created: 2022-12-22T00:07:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-23T19:55:33.000Z (almost 3 years ago)
- Last Synced: 2025-06-04T19:23:38.491Z (12 months ago)
- Topics: fastapi, python, rocketry, todoapi
- Language: Python
- Homepage: https://task-manager-bvue.onrender.com/docs
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Manager
Task Manager is a simple to-do list app built using FastAPI and Rocketry. It allows users to create, update, and delete tasks as well as receive notifications for their tasks. The app also includes an authentication route with user sign up and login endpoints.
**Link to docs: [Task-Manager docs](https://task-manager-bvue.onrender.com/docs)**
## Authentication Route
The authentication route allows users to sign up and log in to the app.
The following endpoints are available:
* **Sign up endpoint**
```python
POST auth/sign-up
```
-- Request example :
```python
curl -X 'POST' \
'https://task-manager-bvue.onrender.com/auth/sign-up' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"username": "guy",
"password": "",
"email": "guy@gmail.com"
}'
```
* **Log in endpoint**
The endpoint will authenticate the user and return a JWT token that can be used to access the Todos route.
```python
POST auth/log-in
```
-- Request example :
```python
curl -X 'POST' \
'https://task-manager-bvue.onrender.com/auth/log-in' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"username": "johndoe",
"password": ""
}'
```
## Todos Route
The Todos route allows users to create, update, and delete tasks as well as receive notifications for their tasks.
The following endpoints are available:
## Tools
      
## Running the App Locally
To run the app locally, follow these steps:
- Clone the repository to your local machine
```console
git clone https://github.com/Lftobs/Task-Manager.git
```
- Navigate to the project directory
```console
cd Task-Manager
```
- Install the project dependencies
```console
pip install -r requirements.txt
```
- Add the necessary environment variables
- Run the application
```console
uvicorn main:app --reload
```
Note: For security purposes, it is recommended to configure a secure secret key for your app and update the SECRET_KEY value in the .env file.