Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chadxz/respoke-app-express-boilerplate
Boilerplate for the server-side portion of a Respoke application
https://github.com/chadxz/respoke-app-express-boilerplate
Last synced: about 1 month ago
JSON representation
Boilerplate for the server-side portion of a Respoke application
- Host: GitHub
- URL: https://github.com/chadxz/respoke-app-express-boilerplate
- Owner: chadxz
- Created: 2015-05-01T22:58:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-05-29T20:21:01.000Z (over 9 years ago)
- Last Synced: 2023-08-03T10:10:30.055Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 277 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# respoke-app-express-boilerplate
Building a node.js web application with authentication involves a great deal of boilerplate to get up and running. This
repo intends to serve as a jumpstart for this scenario. Some features:
- express.js server framework
- local account creation & management
- social signon using twitter, github, and google
- ability to associate existing account with social login methods
- ability to retrieve vanity details about other users that have signed up
- ability to perform Respoke brokered authentication for a logged-in user
some things this project does **not** have:
- no modules that require native addons, making it easy to get started on windows
- no attempt to define look and feel
- no advanced tools (transpilers, minifiers, bundlers, build tools). You can add any of these as needed!
- no requirement of database backend, thanks to nedb database
## getting started
1. `git clone https://github.com/chadxz/respoke-app-express-boilerplate.git --depth=1 your-app-name` to retrieve the repo
with only the most recent history. This makes the clone quick!
1. `cd your-app-name && rm -rf .git` to remove the repo history so you can start your repo fresh
1. `npm install` to install the project dependencies
1. change the project name in `package.json` and `bower.json`, to make the project your own
1. `npm start` to start the server on http://localhost:8080
## configuration for Respoke brokered auth
Out of the box, this application will automatically retrieve a Respoke authentication token for you once
logged in, and provides a route `/respoke/token` to refresh that authentication token if needed. To enable
this functionality, you must provide the server with your Respoke `app id`, `app secret`, and a `roleId`
to be used when requesting a token.
When configured, the default logged-in page has an example of using this token to connect to Respoke.
## obtaining API keys
By default, the project only has local login enabled. To enable social login via google, github, or twitter, you must
obtain the appropriate credentials from the respective service. Once you obtain the necessary credentials, you can copy
`config/default.js` to `config/local.js`, and fill in your credentials under the service's object. Once the credentials
have been filled in, you can toggle the social login method by setting the `enable` property to `true` or `false` as
needed.
- Visit [Google Cloud Console](https://cloud.google.com/console/project)
- Click **CREATE PROJECT** button
- Enter *Project Name*, then click **CREATE**
- Then select *APIs & auth* from the sidebar and click on *Credentials* tab
- Click **CREATE NEW CLIENT ID** button
- **Application Type**: Web Application
- **Authorized Javascript origins**: `http://localhost:8080`
- **Authorized redirect URI**: `http://localhost:8080/auth/google/callback`
- Copy and paste *Client ID* and *Client secret* keys into `config/local.js`
**Note:** When you ready to deploy to production don't forget to add your new url to *Authorized Javascript origins*
and *Authorized redirect URI*, e.g. `http://my-awesome-app.herokuapp.com` and
`http://my-awesome-app.herokuapp.com/auth/google/callback` respectively. The same goes for other providers.
- Go to [Account Settings](https://github.com/settings/profile)
- Select **Applications** from the sidebar
- Then inside **Developer applications** click on **Register new application**
- Enter *Application Name* and *Homepage URL*.
- For *Authorization Callback URL*: `http://localhost:8080/auth/github/callback`
- Click **Register application**
- Now copy and paste *Client ID* and *Client Secret* keys into `config/local.js`
- Sign in at [https://apps.twitter.com/](https://apps.twitter.com/)
- Click **Create a new application**
- Enter your application name, website and description
- For **Callback URL**: `http://localhost:8080/auth/twitter/callback`
- Go to **Settings** tab
- Under *Application Type* select **Read and Write** access
- Check the box **Allow this application to be used to Sign in with Twitter**
- Click **Update this Twitter's applications settings**
- Copy and paste *Consumer Key* and *Consumer Secret* keys into `config/local.js`
## screenshots
## license
[MIT](LICENSE-MIT)