Giter Club home page Giter Club logo

python-todo-list's Introduction

python-todo-list

A web-based todo list built on FastAPI and SQLAlchemy.

Usage

This requires Docker Compose to be installed, along with Docker's BuildKit being enabled.

  1. Create a .env file using the example.env as a template. Adjust passwords as necessary.

  2. Start the services with docker compose up --build --exit-code-from app.

  3. Go to http://localhost:5000 to access the website.

  4. To cleanup the containers/volumes, use docker compose down --volumes.

Development

To run tests, use docker build --target tests ..

If you need to administrate the database during runtime, a pgAdmin instance is provided at the address http://localhost:5433. You can log into pgAdmin using the appropriate email/password credentials defined in .env and then add the database. Note that the hostname specified in the Connections tab should be called "db".

Todo

  • Set up Dockerfile / docker-compose.yml (test by printing "hello world!")
  • Set up FastAPI app (test by accessing from Docker)
  • Set up todo SQLAlchemy models
  • Set up PostgreSQL database with docker (test by committing / fetching data)
  • Create endpoints to interface with todo
  • Add website as front-end for API
  • Add user authentication via API tokens
  • Add login/register page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.