Document Onboarding Process

FraserTooth / japan_grid_carbon_api

API and Backend to Calculate the Current Carbon Intensity of the Japanese Grid...roughly

https://denkicarbon.jp

GNU General Public License v3.0

7 stars 1 forks source link

Document Onboarding Process #15

Open FraserTooth opened 3 years ago

FraserTooth commented 3 years ago

Pull the project and get it running end-to-end. Document the process of:

Setting up your Google Account
Getting the Files placed locally correctly
Getting the API running locally
Pinging the Local API with curl/postman/etc

This is to help newcomers to the project figure it all out.

DhrubojyotiBis1 commented 3 years ago

Hi @FraserTooth I wold like to work in this issue too. Should I add the documentation directly in Readme.md ?

FraserTooth commented 3 years ago

@DhrubojyotiBis1 sure! This is more an on-going ticket so I won't assign it, but if you have any good suggestions yes please add them to the Readme. In a separate PR to the other work 👍