Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 4.02 KB

README.md

File metadata and controls

95 lines (65 loc) · 4.02 KB
Raw

aBitMotivation

Web app for tracking positive habits, leveling up through experience points, and achieving personal growth milestones. Built to promote well-being and habit-building.

Key Features • Getting Started • Contributing • License

home_page

Key Features

  • Create an account to save your progression.

    • register login

  • Navigate between multiple Bits and Objectives

    • layout objectives objective bits bit

  • Create, edit or delete Bits and Objectives to manage attainable goals

    • edit_bit edit_objective

  • Get experience points to gain levels and keep you motivated.

    • Capture d’écran, le 2023-09-20 à 12 00 55

Getting Started

Prerequisites

To run this project, you will need:

  • NodeJS (version 14.20.0 or more)
  • NPM (version 6.14 or more)
  • Python (version 3.7 or more)

Installation and Setup

  1. Clone this repository to your local machine.
git clone https://github.com/Scylidose/aBitMotivation.git
  1. In a first teminal, run the Makefile :
make run-frontend
  1. In a second teminal, run the Makefile :
make run-backend-nodejs
  1. In a third teminal, run the Makefile :
make run-backend-python

This will install all the necessary dependencies and run the Front-end and Back-end (NodeJS and Python) server.

Contributing

Contributions to this project are welcome. If you find a bug, have a feature request, or want to contribute code, please open an issue or pull request on the project's GitHub page.

License

This project is licensed under the CC License. See the LICENSE file for details.