https://github.com/proafxin/bug-tracker

A set of asynchronous APIs to keep track of bugs under stories.
https://github.com/proafxin/bug-tracker

alembic api api-rest async async-await asynchronous asyncio backend codecov docker dockerfile fastapi mysql pydantic pytest pytest-asyncio python trunk

Last synced: 4 months ago
JSON representation

A set of asynchronous APIs to keep track of bugs under stories.

• Host: GitHub
• URL: https://github.com/proafxin/bug-tracker
• Owner: proafxin
• License: apache-2.0
• Created: 2023-08-28T23:40:31.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-06-16T15:30:20.000Z (about 1 year ago)
• Last Synced: 2025-01-12T02:39:22.237Z (6 months ago)
• Topics: alembic, api, api-rest, async, async-await, asynchronous, asyncio, backend, codecov, docker, dockerfile, fastapi, mysql, pydantic, pytest, pytest-asyncio, python, trunk
• Language: Python
• Homepage:
• Size: 162 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bug Tracker

[![Code check](https://github.com/proafxin/bug-tracker/actions/workflows/ci.yml/badge.svg)](https://github.com/proafxin/bug-tracker/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/proafxin/bug-tracker/graph/badge.svg?token=WAJ9M1BUL1)](https://codecov.io/gh/proafxin/bug-tracker)

A set of asynchronous APIs to keep track of bugs under stories.

## Setup

First ensure the following variables are present in your system: `MYSQL_DBNAME`, `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_HOST`, `MYSQL_PORT`. They should be self-explanatory. Also a database with name `MYSQL_DBNAME` should be available already. Install tox and poetry: `pip install tox poetry`. Run `tox` and see all the tests pass.

## API Docs

Install the project first: `poetry install`. Run migration with alembic: `alembic upgrade head`. Then run the command `uvicorn tracker.main:app --reload` and go to `http://127.0.0.1:8000/docs` to test the APIs. Rest should be self-explanatory.