Skip to content

MattiasHenders/gainSON

Repository files navigation

gainSON - Open Source Workouts

gainSON: Because you didn't tell me a better name in time.

Welcome to the open source library for workouts. To get started go to installation to get a copy for yourself.


Table of Contents

Description - Why make this? Who is it for?

Installation - How do I get this for my app?

Request a new Exercise - Can I add an exercise that isn't there?

Contributors - Who helped out with this project?

Roadmap - Where is this project going?


Description

This repo is an effort for future developers to easily get a database of exercises in JSON format for any kind of development that may need it.

Developing apps is hard enough, you shouldn't waste time creating your own database of workouts. Focus on your app, let this repo handle the database of exercises.


Installation

Clone the repo:

git clone https://github.com/MattiasHenders/gainSON.git

Open the project in your favourite compiler:

SaveJSONGUI.main > Run

Run the main method and follow the GUI:

> Select path and file name
> Click GENERATE JSON

The JSON will appear in the chossen directory.

NOTE: As there is no database hosted yet, you will be unable to generate. Getting close to that point though!

View the roadmap to see our plan to get to a better user experience


Request a New Exercise

To request a new exercise to the database click here to send a submission!

If you don't want to fill the template out just request it the same way. It just might take more time to get to.

Tag for submitting a new exercise.


Contributors

We add devs with accepted pull requests. Also any meaningful contributions.


Roadmap

These are the goals we hope to hit mostly in order. Create an issue if you want to add to this.

Milestones

  • Create the basic JSON object format
  • Create the database with exercises
  • Generate a JSON from the SQL database
  • Dynamically grab the columns and generate the JSON that way instead of hard coding
  • Allow for users to select how they want their JSON to be created
  • Allow the JSON to be saved to the computer
  • Create a UI/Create an executable app .exe
  • Create a form for other people to submit their own exercise data
  • Add a solid amount of exercises, most workout apps have around 100 so we hope to exceed that
  • Host a website for quick downloads of the full and some custom JSONs
  • Use the website to host the JSON
  • Create an API to access the JSON dynamically from apps, not from running .exe

gainSON: Because you didn't tell me a better name in time.

Copyright 2021 - Mattias Henders

Releases

No releases published

Packages

No packages published