https://github.com/ahmad2b/dodone

https://github.com/ahmad2b/dodone

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ahmad2b/dodone
• Owner: ahmad2b
• Created: 2024-03-17T06:39:01.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-24T06:13:09.000Z (9 months ago)
• Last Synced: 2024-03-24T23:23:56.386Z (9 months ago)
• Language: Python
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dodone

Dodone is a FastAPI based web application that provides a RESTful API for managing tasks.

## Table of Contents

- [Dodone](#dodone)

  - [Table of Contents](#table-of-contents)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Project Structure](#project-structure)

  - [Testing](#testing)

  - [License](#license)

## Installation

This project uses [Poetry](https://python-poetry.org/) for dependency management. You can install the project dependencies with:

```sh

poetry install

```

## Usage

To run the application, use the following command:

```sh

poetry run uvicorn app.main:app --reload

```

## Project Structure

Here is a brief overview of the project's structure:

```plaintext

app/

    __init__.py

    api/

        __init__.py

        deps.py

        main.py

        routes/

            __init__.py

            login.py

            todos.py

            users.py

            utils.py

    core/

        __init__.py

        config.py

        crud.py

        db.py

        security.py

    crud.py

    main.py

    models.py

    utils.py

tests/

    __init__.py

```

## Testing

To run the tests, use the following command:

```sh

poetry run pytest

```

## License

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file for details.