Skip to content

quentingenet/open_weight_tracker

Repository files navigation

Open Weight Tracker

React TypeScript Python DjangoREST PostgreSQL Debian Raspberry Pi
OpenWeightTracker (OWT) is a free and open-source application released under the Copyleft license.
It provides a simple and user-friendly way to track your weight while respecting your data and privacy.

Coming soon on OWT just here !

Technologies

OWT is developed using Python for the backend, along with the Django REST framework,
For the frontend, the application is developed with React.

How to run project?

Follow these steps to run the Open Weight Tracker locally:

Prerequisites

Make sure you have the following installed:

Clone the repository

git clone https://github.com/quentingenet/open_weight_tracker.git

Don't forget to create your personal .env file for the environment variables used in the project (front and back)

Backend Setup

Assuming you have Python3 and pip installed, you should create your virtual environment and activate it.

python3 -m venv venv
source venv/bin/activate
cd open_weight_tracker/owt_back
pip install -r requirements.txt
cd open_weight_tracker/owt_back/src
python manage.py makemigrations
python manage.py migrate

Start the backend server

cd open_weight_tracker/owt_back/src
python manage.py runserver

Backend server is currently running on http://localhost:8000

Frontend Setup

In a separate terminal, install and start the frontend

cd open_weight_tracker/owt_front
npm install

Start the frontend server

cd open_weight_tracker/owt_front
npm run dev

Visit http://localhost:5173 in your web browser to see the Open Weight Tracker application.

How to contribute ?

There are opportunities for further improvements and ideas.
Contributions and pull requests are welcome !
Nobody should be restricted by the software they use. There are four freedoms that every user should have:

  • the freedom to use the software for any purpose,
  • the freedom to change the software to suit your needs,
  • the freedom to share the software with your friends and neighbors,
  • the freedom to share the changes you make.

Author and contributors

  • Quentin GENET
  • Maybe you as contributor... ? 😄🚀

OWT preview