Skip to content

Commit 7a2c8cc

Browse files
committed
readme modified
1 parent 88bc6eb commit 7a2c8cc

File tree

1 file changed

+80
-5
lines changed

1 file changed

+80
-5
lines changed

README.md

Lines changed: 80 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,85 @@
1-
### Hexlet tests and linter status:
1+
Hexlet Tests and SonarCloud
22
[![Actions Status](https://github.com/olyapka84/python-project-52/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/olyapka84/python-project-52/actions)
3+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=olyapka84_python-project-52&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=olyapka84_python-project-52)
34

4-
# Task Manager (Hexlet Project 52)
5+
# Task Manager
56

6-
Финальный проект курса Python на Хекслете — менеджер задач на Django.
7+
Task Manager is a web application built with Django that allows users to register, log in, and manage tasks with statuses and labels.
8+
It’s a simple but fully functional project management tool created as the final project of the Hexlet Python Developer course.
79

8-
## Деплой
10+
---
911

10-
Приложение доступно по адресу: [https://python-project-52-76f1.onrender.com/](https://python-project-52-76f1.onrender.com/)
12+
## Demo
13+
14+
Deployed on Render:
15+
https://python-project-52-76f1.onrender.com/
16+
17+
---
18+
19+
## Features
20+
21+
- User registration and authentication
22+
- CRUD operations for:
23+
- Tasks (title, description, status, author, executor)
24+
- Statuses (e.g. "New", "In progress", "Done")
25+
- Labels for flexible task categorization
26+
- Access control: users can edit or delete only their own tasks
27+
- Flash messages for user feedback (success/error notifications)
28+
- Deployed with PostgreSQL and environment variables on Render
29+
30+
---
31+
32+
## Tech Stack
33+
34+
- Backend: Django 5.x
35+
- Database: PostgreSQL
36+
- Frontend: Django Templates, Bootstrap
37+
- Testing: pytest
38+
- Code quality: SonarCloud
39+
40+
---
41+
42+
## Local Setup
43+
44+
Clone the repository and install dependencies with uv:
45+
46+
- git clone https://github.com/olyapka84/python-project-52.git
47+
- cd python-project-52
48+
- uv sync
49+
50+
Create a .env file in the project root:
51+
52+
DEBUG=True
53+
SECRET_KEY=your_secret_key
54+
DATABASE_URL=postgresql://USER:PASSWORD@localhost:5432/task_manager
55+
56+
Run database migrations:
57+
58+
- make migrate
59+
60+
Start the development server:
61+
62+
- make start
63+
64+
or directly:
65+
66+
- uv run python manage.py runserver 0.0.0.0:8000
67+
68+
Then open the app at:
69+
http://localhost:8000/
70+
71+
---
72+
73+
## Testing
74+
75+
Run the full test suite:
76+
77+
- make test
78+
79+
---
80+
81+
## About
82+
83+
This project was developed as part of the Hexlet Python Developer program.
84+
- Author: Olga Akukina (https://github.com/olyapka84)
85+
- Hexlet: https://hexlet.io

0 commit comments

Comments
 (0)