From 5004c78ee651ff34aad60dc5bb200f05eb4ee1bc Mon Sep 17 00:00:00 2001 From: Peter Morgan Date: Mon, 23 Dec 2019 16:54:05 -0500 Subject: [PATCH] Updated .gitingore and Readme.md for using .env --- .gitignore | 1 + README.md | 20 +++++++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 812bc3b..f965bc5 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ /node_modules/.bin /node_modules /package-lock.json +.env \ No newline at end of file diff --git a/README.md b/README.md index 77b9cb2..b9ec3f2 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,12 @@ Website for visualizing a persons github network. ![Example Graph](./doc/graphExample.png) -If you are lucky, you can find the site live -[here](https://github-graphs.com/); +If you are lucky, you can find the site live [here](https://github-graphs.com/); # Built With -- [BootStrap](https://getbootstrap.com/) CSS Framework +- [BootStrap](https://getbootstrap.com/) - [jQuery](https://jquery.com/) - [Vis JS](http://visjs.org/) - [Github v3 API](https://developer.github.com/v3/) @@ -21,8 +20,14 @@ If you are lucky, you can find the site live # Running -Update your conf.json file to contain your preferred port and github -api credentials. +Create a .env file with the code below filled in. + +``` +CLIENT_ID = +CLIENT_SECRET = +SESSION_SECRET = +PORT = +``` ```bash npm install @@ -35,7 +40,4 @@ node server.js # Contributing -If you want to contribute to this project and don't know where to start, -look at the open issues. Once you know what you want to work on, -just discuss it in the issues and file a pull request. We are very open -to new contributes. \ No newline at end of file +We are very open to new contributors. If you want to contribute to this project, and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues). Once you know what you want to work on, comment on the issue and file a pull request. \ No newline at end of file