Skip to content
This repository has been archived by the owner on Apr 13, 2024. It is now read-only.

Commit

Permalink
docs(oauth): include oauth configuration for local environment
Browse files Browse the repository at this point in the history
  • Loading branch information
alxpez committed Sep 29, 2018
1 parent 8a5a859 commit c0e69d0
Show file tree
Hide file tree
Showing 4 changed files with 3,164 additions and 4 deletions.
23 changes: 23 additions & 0 deletions README.md
Expand Up @@ -158,6 +158,29 @@ Navigate to `localhost:5000` to serve (a production-ready) vuegg.

</br>

### Connect with github

Vuegg makes use of `.env` files to set up some environment variables. The current setup allows you to have 3 files with different configurations: `.env`, `.env.dev` and/or `.env.test`, containing the following variables:

``` yaml
# Create an OAuth App on github and use your client ID and Secret

CLIENT_ID=y0urcl13nt1d
CLIENT_SECRET=y0urcl13nts3cr3t
CALLBACK_URL=http://localhost:8000/auth
```

> This files should exist only on your local machine, do not add them to the git repository.
Now if you wish to test out the *connect with github* functionality on your local environment, it's necessary to run vuegg-client and vuegg-server through the following command:

``` bash
npm run oauth
```
You should be prompted with 3 options to pick. Run server and client in separate terminal instances.

</br>

## History & current state

The project was born as a sandbox for me to get started on the [vue](https://github.com/vuejs/vue) world, in fact its ~~un~~original name was vuexample (*very unique*, I thought at the time).
Expand Down
3 changes: 1 addition & 2 deletions client/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c0e69d0

Please sign in to comment.