Update README.md

This commit is contained in:
Allan Cueff
2022-12-27 20:40:25 +01:00
committed by GitHub
parent e311f52c27
commit 97db922f39

View File

@@ -1,18 +1,10 @@
# strava-free-year-in-sport
Strava "Year in Sport", but for free using strava API
Strava "Year in Sport", but for free using strava API. Please read the [WIKI](https://github.com/allan-cff/strava-free-year-in-sport/wiki) & [Strava API terms & conditions](https://www.strava.com/legal/api) before any use.
## Note :
This is just a personal project for fun. We do not intend to compete with Strava in any way.
This is just a personal project for fun. This project is not intended to be deployed to the general public. We do not intend to compete with Strava in any way.
This project is still in active development, so it may not give you the result you expect. Feel free to make suggestions !
HTML is currently in french only, may implement a language change system later but that's not a priority. JS code is in english.
## How to install :
* Install Node JS on https://nodejs.org/
* Create your own Strava APP on https://www.strava.com/settings/api
* rename hidden.env to .env and replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET by your own Strava APP values
* Download dependances (only once) with `npm i`
## How to run :
* Run with `npm start`
* Open `localhost:8080` on wour web browser
## Future improvements
HTML is currently in french only, may implement a language change system later but that's not a priority.