An open API service indexing awesome lists of open source software.

https://github.com/dylanbk/momentum

A productivity web app to motivate you to get done what needs to be done.
https://github.com/dylanbk/momentum

flask motivation productivity python sqlalchemy tailwindcss typescript

Last synced: about 2 months ago
JSON representation

A productivity web app to motivate you to get done what needs to be done.

Awesome Lists containing this project

README

          

# Momentum

## What is Momentum?

Momentum is a productivity web app designed with the intent to allow people to track tasks they need to do and mark them as done when completed, this lets people see a visual indicator of how much stuff they have achieved and what needs to be done.

---

## How was Momentum built?

The front end side of the site is composed of React, TailwindCSS, and plain CSS whilst the back end is built using Flask and SQLAlchemy. The fetch API is used to make requests to the server and Flask is used to handle those requests, and SQLAlchemy handles all database interactions.

### Front End Stack

![Static Badge](https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=FFF&style=flat-square)
![Static Badge](https://img.shields.io/badge/React-%2320232a.svg?style=flat-square&logo=react&logoColor=%2361DAFB)
![Static Badge](https://img.shields.io/badge/TailwindCSS-%2338B2AC.svg?style=flat-square&logo=tailwind-css&logoColor=white)
![Static Badge](https://img.shields.io/badge/CSS-blue?style=flat-square&logo=css3&logoColor=white)

### Back End Stack

![Static Badge](https://img.shields.io/badge/Python-blue?style=flat-square&logo=python&logoColor=yellow)
![Static Badge](https://img.shields.io/badge/Flask-blue?style=flat-square&logo=flask&logoColor=white)
![Static Badge](https://img.shields.io/badge/SQLAlchemy-D71F00?style=flat-square&logo=sqlalchemy&logoColor=white)

---

## Get Started

### $\textsf{{\color[rgb]{1.0, 0.0, 0.0}Warning}}$

$\textsf{{\color[rgb]{1, 0, 0}This project is still under development so it is unlikely to work as expected.}}$

To run this application you need to have Node.js and Python installed on your machine. You will also be required to install the necessary packages.

Once you have downloaded all files and extracted them, do the following:

### Windows

- Open the terminal by press Win + S and selecting Command Prompt
- In the terminal execute the following:
- `cd path/to/folder`
- `npm install`
- `cd backend`
- `pip install -r requirements.txt`
- `python app.py`
- Open a new instance of the terminal
- Execute the following:
- `cd path/to/folder`
- `cd frontend`
- `npm install`
- `npm run dev`

The website will now open in a new tab in your browser and is ready to use.