https://github.com/mikeyangyo/tasks-management-system
a tasks management system build with python flask, mysql, docker
https://github.com/mikeyangyo/tasks-management-system
docker flask mysql nginx python uwsgi
Last synced: 6 months ago
JSON representation
a tasks management system build with python flask, mysql, docker
- Host: GitHub
- URL: https://github.com/mikeyangyo/tasks-management-system
- Owner: mikeyangyo
- License: mit
- Created: 2021-04-06T03:49:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-30T06:19:59.000Z (over 4 years ago)
- Last Synced: 2025-02-01T18:43:04.821Z (8 months ago)
- Topics: docker, flask, mysql, nginx, python, uwsgi
- Language: Python
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tasks-management-system
> a tasks management system apis to manage todo list
A tasks management system apis to management todo list.
Build with Flask, Mysql, Docker
## Usage example
1. Use below command to start api application.
```sh
docker-compose up -d --build
```
2. run migration commands to create table in MySQL database
```sh
FLASK_APP=app.py flask run-migrations
```
3. visit following api endpoints to interacte with system.
- List tasks
```
GET /tasks
```
- Retrieve task
```
Get /tasks/:id
```
- Create task
```
POST /tasks
```
- Update task
```
PUT /tasks/:id
```
- Delete task
```
DELETE /tasks/:id
```
## Development setup
you can use envs listed below to setup a dev env easily.
- devcontainer
- gitpod
- docker
Or install module dependencies with
1. pip
```sh
pip install -r requirements
```
2. [Poetry](https://python-poetry.org/)
```sh
poetry install
```
- Hints:
- Create new migration need to follow the filename pattern (`...sql`)
## Meta
MikeYang – [@mikeyangyo](https://twitter.com/mikeyangyo) – perryvm06vm06@gmail.com
Distributed under the MIT license. See ``LICENSE`` for more information.
[https://github.com/mikeyangyo/](https://github.com/mikeyangyo/)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
4. Commit your changes (`git commit -am 'Add some fooBar'`)
5. Run test before pushing (`pytest`)
6. Push to the branch (`git push origin feature/fooBar`)
7. Create a new Pull Request