Giter Club home page Giter Club logo

bulldoggy-reminders-app's Introduction

Bulldoggy Logo

Bulldoggy: The Reminders App

Bulldoggy is a small demo web app for tracking reminders. It uses:

I first shared Bulldoggy in my PyTexas 2023 keynote, Full-Stack Python.

Installing dependencies

You will need a recent version of Python to run this app. To install project dependencies:

pip install -r requirements.txt

It is recommended to install dependencies into a virtual environment.

Running the app

To run the app:

uvicorn app.main:app --reload

Then, open your browser to http://127.0.0.1:8000 to load the app.

Logging into the app

The config.json file declares the users for the app. You may use any configured user credentials, or change them to your liking. The "default" username is pythonista with the password I<3testing.

Setting the database path

The app uses TinyDB, which stores the database as a JSON file. The default database filepath is reminder_db.json. You may change this path in config.json. If you change the filepath, the app will automatically create a new, empty database.

Using the app

Bulldoggy is a reminders app. After you log in, you can create reminder lists.

Bulldoggy login

Each reminder list appears on the left, and the items in the list appear on the right. You may add, delete, or edit lists and items. You may also strike out completed items.

Bulldoggy reminders

Reading the docs

To read the API docs, open the following pages:

  • /docs for classic OpenAPI docs
  • /redoc for more modern ReDoc docs

Why did I build this app in Python?

Personally, I love Python, and I wanted to demonstrate how to build a full-stack modern web app entirely with Python.

JavaScript essentially has a near-monopoly on front-end web development. Browsers require JavaScript code to perform dynamic web page interactions. However, HTMX offers a novel way to sidestep this limitation: it provides special HTML attributes to denote dynamic interactions for elements. Under the hood, HTMX uses AJAX to issue HTTP requests and swap hypertext contents for elements targetted with its special attributes. JavaScript is still there โ€“ you just don't need to touch it!

This enables web frameworks in languages like Python, Go, Java, and others to offer dynamic web page content directly in HTML without requiring developers to explicitly code any JavaScript. HTMX empowers you, as a developer, to build beautiful web apps while remaining in the tech stack of your choice!

To learn more about this app's design, please watch my PyTexas 2023 keynote, Full-Stack Python.

Credits

TODO list

  • Automate API tests
  • Automate UI tests
  • Automate unit tests

bulldoggy-reminders-app's People

Contributors

automationpanda avatar

Stargazers

Joseph Peter avatar

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.