Create README.md

This commit is contained in:
Annyv2 2015-11-23 19:57:18 -04:30
parent d06501e315
commit cf81a579a5

22
example/README.md Normal file
View File

@ -0,0 +1,22 @@
# Auth0 + Socket.io
This is the seed project you need to use if you're going to create a Socket.io single page app that will use Auth0.
## Running the example
In order to run the example, you need to have `node` installed.
You also need to set the ClientSecret, ClientId and Domain for your Auth0 app as variables with the following names respectively: `AUTH0_CLIENT_SECRET`, `AUTH0_CLIENT_ID` and `AUTH0_DOMAIN`.
````bash
# auth0-variables.js file
AUTH0_CLIENT_SECRET=myCoolSecret
AUTH0_CLIENT_ID=myCoolClientId
AUTH0_DOMAIN=samples.auth0.com
````
On your application in Auth0 you need to set http://localhost:3001 as an Allowed Origin (CORS) in the application settings page.
1. run npm install
1. run node index.js in the directory of this project.
Go to [http://localhost:3001](http://localhost:3001) and you'll see the app running :).