diff --git a/README.md b/README.md index 7c7908c..c721522 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Website for visualizing a persons github network. If you are lucky, you can find the site live [here](https://github-graphs.com/); -# Built With +## Built With - [BootStrap](https://getbootstrap.com/) - [jQuery](https://jquery.com/) @@ -16,21 +16,45 @@ If you are lucky, you can find the site live [here](https://github-graphs.com/); ![javascript](./doc/javaScript.jpg) -# Running +## Running -Create a .env file with the code below filled in. +The easiest way to get started with Github-Graphs is to fork this repository +and follow the instructions below. + +### Create a new OAuth app + +The objective of creating an app under your github account is to access an +endpoint through the GitHub API and obtain credentials to set your environment +file. For directives on how to create a new OAuth app, consult the corresponding +Github developer documentation [here](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/); + +### Create a .env file + +Setup your environment credentials by creating a `.env file` inside the folder +`/server` with the code below filled in. ``` -CLIENT_ID = -CLIENT_SECRET = +CLIENT_ID = +CLIENT_SECRET = SESSION_SECRET = PORT = ``` +### Install dependencies + +Dependencies are installed using `npm`. Therefore, please install the package manager +before proceeding. If you already have `npm` installed, run the command below inside +`/server` in order to install the dependencies in the package directory. + ```bash npm install ``` +### Activate GitHub-Graphs + +Inside `/server`, run the following command to start the program, and in your +browser, check `localhost:8000` to visualize your Github network. + ```bash node server.js ```