mirror of
https://github.com/Cronocide/fitbit-web-ui-app.git
synced 2025-01-22 11:29:03 +00:00
Updated documentation
All checks were successful
git.cronocide.net/fitbit-web-ui-app/pipeline/head This commit looks good
All checks were successful
git.cronocide.net/fitbit-web-ui-app/pipeline/head This commit looks good
This commit is contained in:
parent
4f35fb1bdd
commit
18f3944a91
GPG Key ID:
1CADA052F64664EC
30
README.md
30
README.md
@ -1,27 +1,25 @@
|
||||
# Fitbit Wellness Report Web UI
|
||||
<center><h1>Fitbit Wellness Report Web UI</h1>
|
||||
<span>by Arpan Ghosh</span>
|
||||
<br><br>
|
||||
<a href="https://fitbit-api-web-ui.onrender.com/"><img src="https://img.shields.io/badge/Live_Demo-Website-blue" alt="Live Demo Website" /></a> <a href="https://fitbit-api-web-ui.onrender.com/"><img src="https://img.shields.io/badge/Self_Hosted-Alternative-green" alt="Self Hosted Alternative website" /></a>
|
||||
</center>
|
||||
|
||||
[Live Demo website](https://fitbit-api-web-ui.onrender.com/)
|
||||
<br>
|
||||
|
||||
[Self Hosted Alternative website](https://fitbit-report.arpan.app/)
|
||||
|
||||
|
||||
[How to get ACCESS TOKEN](https://github.com/arpanghosh8453/fitbit-web-ui-app/blob/main/help/GET_ACCESS_TOKEN.md)
|
||||
## Building
|
||||
|
||||
|
||||
This app takes no build arguments. To build the container:
|
||||
|
||||
# Self-Hosting with Docker
|
||||
`docker build -t fitbit-web-ui fitbit-web-ui-app/`
|
||||
|
||||
The following docker container `thisisarpanghosh/fitbit-report-app` is available for self hosting of this project. The Web app will be available on http://localhost:5000 with the configuration below.
|
||||
## Configuration
|
||||
|
||||
```
|
||||
services:
|
||||
fitbit-ui:
|
||||
image: 'thisisarpanghosh/fitbit-report-app:latest'
|
||||
container_name: 'fitbit-report-app'
|
||||
ports:
|
||||
- "5000:80"
|
||||
restart: unless-stopped
|
||||
```
|
||||
The variables `CLIENT_ID`, `CLIENT_SECRET`, and `REDIRECT_URL` need to be set to self-host this application. Instructions for getting these values can be found [here](https://dev.fitbit.com/build/reference/web-api/developer-guide/getting-started/).
|
||||
|
||||
## Contributions
|
||||
|
||||
Thanks to [@arpanghosh8453](https://github.com/arpanghosh8453) for sharing their work on the Fitbit API and the report design, and for sharing this project with the world.
|
||||
|
||||
Special thanks to [@dipanghosh](https://github.com/dipanghosh) for his help and contribution towards the sleep schedule analysis part of the script and overall aesthetics suggestions.
|
||||
|
||||
@ -1,77 +0,0 @@
|
||||
# **How to get Fitbit API Access Token**
|
||||
|
||||
|
||||
|
||||
## 1. Method one : Official way
|
||||
|
||||
|
||||
|
||||
|
||||
1. Visit [this page](https://dev.fitbit.com/build/reference/web-api/developer-guide/getting-started/) and follow tutorial to create your own application
|
||||
|
||||
2. Open [this page](https://dev.fitbit.com/build/reference/web-api/troubleshooting-guide/oauth2-tutorial/?clientEncodedId=23R3K5&redirectUri=https://localhost:8000/&applicationType=PERSONAL) and continue the process
|
||||
|
||||
3. After you authorize your own application, you will get a ACCESS TOKEN and REFRESH TOKEN after following the whole process
|
||||
|
||||
|
||||
|
||||
|
||||
## Method two : Quick way
|
||||
|
||||
|
||||
|
||||
|
||||
1. Open a tab in the browser and visit [https://dev.fitbit.com/login](https://dev.fitbit.com/login)
|
||||
|
||||
2. Login if you are not logged in the current browser session
|
||||
|
||||
3. Open [this page](https://dev.fitbit.com/build/reference/web-api/explore/) and click on the green Authorize button, click select all to select all the checkbox options and hit “Authorize” button below the dialog box. Then you will see another dialog appear with logout and close button. Now you should hit close
|
||||
|
||||
|
||||
|
||||
4. Scroll down to the Devices section.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click on “Try it out” and then click on “Execute” button
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
6. You will see the API key in the curl command section. **Carefully copy only the part after the first line ( ending in Bearer )**
|
||||
|
||||
|
||||
|
||||
|
||||
The “*curl -X GET "https://api.fitbit.com/1/user/-/devices.json" -H "accept: application/json" -H "authorization: Bearer*” **line is NOT a part of your API key.**
|
||||
|
||||
|
||||
|
||||
Also, avoid the quotation mark (“) at the end of the API key when you copy
|
||||
|
||||
|
||||
|
||||
I have blurred the API key part here in the above image.
|
||||
|
||||
It looks like a long continuous alphanumeric blob of characters without any space or meaningful word. Just copy the API key part.
|
||||
|
||||
|
||||
|
||||
**REMEMBER : Each API key has an hourly call limit and expires forever after 8 hours. One key will not work forever. If you use the same key in quick succession, you may hit the hourly rate limit.**
|
||||
Loading…
Reference in New Issue
Block a user