isabella232 / winterns2020

2020 Winternship Public API Explorer

For this winternship, we are building a proof of concept for a public API explorer. Users can interface with the different endpoints, or access information from them more easily without needing to run curl requests.

Wintern Leads Points of Contact

Slack us, find us in person, ask us anything!

Backend - Grace, Gabriel, Diana
Frontend - David, Kevin
QA - Pawan

Gitpod Setup & Saving Work to Github

1. Open a workspace in gitpod by going to https://gitpod.io/github.com/bitly/winterns2020 or add the chrome extension (which adds the GitPod button to your Github account)
2. Create a new branch off of master git checkout -b <YOUR BRANCH>
3. Make your changes
4. Commit changes to Github using the commands git add <file names> , git commit -m "commit message", git push --set-upstream origin <YOUR BRANCH> (this --set-upstream parameter will only have to be used the first time you push your branch to the remote, from then on you can just do git push)
5. On winterns2020 repo in Github, navigate to branches, find your branch, and click on the open pull request button.

Run Locally

1. Make sure that you are in the directory with the app.py file (you can determine this by typing ls -l into the command line to list the files your current directory and ensuring that you see app.py there)
2. Install node packages through npm install
3. Install flask through requirements.txt file, pip install -r requirements.txt
4. In one terminal, run npm run start. This will build and start the React web app.
5. In a second terminal, run flask run --reload --debugger. This will run the Flask app on an HTTP server.
6. You will see a log pop up in the console indicating that your application is * Running on http://127.0.0.1:5000/
7. To view your webapp, click on http://127.0.0.1:5000/ to open it in a new tab, or preview in the sidebar.

That's it! 🎉

PS: sample-app.py to hit endpoints in flask/python

sample-app.py