https://github.com/passport/todos-express-email
Todo app using Express, Passport, and SendGrid for sign in with email.
https://github.com/passport/todos-express-email
email example express magic-link nodejs passport passwordless sendgrid sqlite
Last synced: 15 days ago
JSON representation
Todo app using Express, Passport, and SendGrid for sign in with email.
- Host: GitHub
- URL: https://github.com/passport/todos-express-email
- Owner: passport
- License: unlicense
- Created: 2021-08-26T00:49:11.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-11T18:54:37.000Z (over 1 year ago)
- Last Synced: 2025-05-08T01:29:18.824Z (22 days ago)
- Topics: email, example, express, magic-link, nodejs, passport, passwordless, sendgrid, sqlite
- Language: CSS
- Homepage:
- Size: 415 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# todos-express-email
This app illustrates how to use [Passport](https://www.passportjs.org/) with
[Express](https://expressjs.com/) to sign users in with email. 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-email.git
$ cd todos-express-email
$ npm install
```
This app must be configured with a SendGrid API key.
Once credentials have been obtained, create a `.env` file and add the following
environment variables:
```
SENDGRID_API_KEY=__INSERT_API_KEY_HERE__
```
Start the server.
```bash
$ npm start
```
Navigate to [`http://localhost:3000`](http://localhost:3000).
## Tutorial
Follow along with the step-by-step [Email Magic Link Tutorial](https://www.passportjs.org/tutorials/email/)
to learn how this app was built.
## Overview
This app illustrates how to build a todo app with sign in functionality using
Express, Passport, and the [`passport-magic-link`](https://www.passportjs.org/packages/passport-magic-link/)
strategy.
This app is a traditional web application, in which application logic and data
persistence resides on the server. HTML pages and forms are rendered by the
server and client-side JavaScript is not utilized (or kept to a minimum).
This app is built using the Express web framework. Data is persisted to a
[SQLite](https://www.sqlite.org/) database. HTML pages are rendered using [EJS](https://ejs.co/)
templates, and are styled using vanilla CSS.
When a user first arrives at this app, they are prompted to sign in. To sign
in, the user clicks a magic link that is sent to their email address via
[SendGrid](https://sendgrid.com/)'s API. Once authenticated, a login session is
established and maintained between the server and the user's browser with a
cookie.
After signing in, the user can view, create, and edit todo items. Interaction
occurs by clicking links and submitting forms, which trigger HTTP requests.
The browser automatically includes the cookie set during login with each of
these requests.
When the server receives a request, it authenticates the cookie and restores the
login session, thus authenticating the user. It then accesses or stores records
in the database associated with the authenticated user.
## License
[The Unlicense](https://opensource.org/licenses/unlicense)
## Credit
Created by [Jared Hanson](https://www.jaredhanson.me/)