https://github.com/passport/todos-express-openidconnect
Todo app using Express, Passport, and SQLite for sign in via OpenID Connect.
https://github.com/passport/todos-express-openidconnect
example express nodejs openid-connect passport sqlite
Last synced: about 2 months ago
JSON representation
Todo app using Express, Passport, and SQLite for sign in via OpenID Connect.
- Host: GitHub
- URL: https://github.com/passport/todos-express-openidconnect
- Owner: passport
- License: unlicense
- Created: 2015-08-11T18:40:04.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-04-13T20:52:01.000Z (about 3 years ago)
- Last Synced: 2025-05-08T01:33:35.556Z (about 2 months ago)
- Topics: example, express, nodejs, openid-connect, passport, sqlite
- Language: CSS
- Homepage:
- Size: 20.5 KB
- Stars: 24
- Watchers: 3
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# todos-express-openidconnect
This app illustrates how to use [Passport](https://www.passportjs.org/) with
[Express](https://expressjs.com/) to sign users in via OpenID Connect. Use this
example as a starting point for your own web applications.
## Quick Start
To run this app, clone the repository and install dependencies:
```bash
$ git clone https://github.com/passport/todos-express-openidconnect.git
$ cd todos-express-openidconnect
$ npm install
```
This app must be configured with an OpenID Provider (OP)'s endpoints, as well as
a client ID and secret that has been issued by the OP.
The endpoints should be set as options to `OpenIDConnectStrategy` in
[routes/auth.js](https://github.com/passport/todos-express-openidconnect/blob/master/routes/auth.js#L7-L10).
Once the client ID and secret have been obtained, create a `.env` file and add
the following environment variables:
```
CLIENT_ID=__INSERT_CLIENT_ID_HERE__
CLIENT_SECRET=__INSERT_CLIENT_SECRET_HERE__
```
Start the server.
```bash
$ npm start
```
Navigate to [`http://localhost:3000`](http://localhost:3000).
## Overview
This example illustrates how to use Passport and the [`passport-openidconnect`](https://www.passportjs.org/packages/passport-openidconnect/)
strategy within an Express application to sign users in via OpenID Connect.
This app implements the features of a typical [TodoMVC](https://todomvc.com/)
app, and adds sign in functionality. This app is a traditional web application,
in which all application logic and data persistence is handled on the server.
User interaction is performed via HTML pages and forms, which are rendered via
[EJS](https://ejs.co/) templates and styled with vanilla CSS. Data is stored in
and queried from a [SQLite](https://www.sqlite.org/) database.
After users sign in, a login session is established and maintained between the
server and the browser with a cookie. As authenticated users interact with the
app, creating and editing todo items, the login state is restored by
authenticating the session.
## License
[The Unlicense](https://opensource.org/licenses/unlicense)
## Credit
Created by [Jared Hanson](https://www.jaredhanson.me/)