Browse Source

Updated .gitingore and Readme.md for using .env

pull/18/head
Peter Morgan 4 years ago
parent
commit
5004c78ee6
2 changed files with 12 additions and 9 deletions
  1. +1
    -0
      .gitignore
  2. +11
    -9
      README.md

+ 1
- 0
.gitignore View File

@ -6,3 +6,4 @@
/node_modules/.bin /node_modules/.bin
/node_modules /node_modules
/package-lock.json /package-lock.json
.env

+ 11
- 9
README.md View File

@ -4,13 +4,12 @@ Website for visualizing a persons github network.
![Example Graph](./doc/graphExample.png) ![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 # Built With
- [BootStrap](https://getbootstrap.com/) CSS Framework
- [BootStrap](https://getbootstrap.com/)
- [jQuery](https://jquery.com/) - [jQuery](https://jquery.com/)
- [Vis JS](http://visjs.org/) - [Vis JS](http://visjs.org/)
- [Github v3 API](https://developer.github.com/v3/) - [Github v3 API](https://developer.github.com/v3/)
@ -21,8 +20,14 @@ If you are lucky, you can find the site live
# Running # 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 ```bash
npm install npm install
@ -35,7 +40,4 @@ node server.js
# Contributing # 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.
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.

Loading…
Cancel
Save