https://github.com/Dramloc/preact-auth0-template

A simple `preact-cli` template for auth0
https://github.com/Dramloc/preact-auth0-template

auth0 preact preact-cli

Last synced: 20 days ago
JSON representation

A simple `preact-cli` template for auth0

• Host: GitHub
• URL: https://github.com/Dramloc/preact-auth0-template
• Owner: Dramloc
• License: mit
• Created: 2017-11-25T11:56:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-05-13T16:26:31.000Z (about 6 years ago)
• Last Synced: 2024-03-04T22:35:30.938Z (4 months ago)
• Topics: auth0, preact, preact-cli
• Language: JavaScript
• Homepage: https://preact-auth0.surge.sh/
• Size: 184 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - Dramloc/preact-auth0-template - A simple `preact-cli` template for auth0 (JavaScript)

README

        
# preact-auth0-template

## Documentation

- This is a simple `preact-cli` template for [auth0](https://auth0.com/). Live demo is available [here](https://preact-auth0.surge.sh/).

- [For Preact](https://preactjs.com/): General information about how to work with Preact, not specific to this template

## Usage

``` bash

$ npm install -g preact-cli

$ preact create dramloc/preact-auth0-template my-project

$ cd my-project

$ npm install

$ npm run dev

```

Development server runs on port `8080`. If the default port is already in use on your machine it will start the development server on a random port.

## Commands

- `npm run start`: Runs `serve` or `dev`, depending on `NODE_ENV` value. Defaults to `dev server`

- `npm run dev`: Run a development, HMR server

- `npm run serve`: Run a production-like server

- `npm run build`: Production-ready build

- `npm run lint`: Pass JavaScript files using ESLint

- `npm run test`: Run Jest and [`preact-render-spy`](https://github.com/mzgoddard/preact-render-spy) for your tests

### How to Test

The `default` template provides a basic test setup with Jest and [`preact-render-spy`](https://github.com/mzgoddard/preact-render-spy). You are free to change preact-render-spy with any other assertion library. The advantage of it is that it supports a similiar terminology and feature set as the Enzyme library for testing React applications.

You can run all additional Jest CLI commands with the `npm run test` command as described in the [Jest docs](https://facebook.github.io/jest/docs/en/cli.html#using-with-npm-scripts). For example, running jest in watch mode would be :

- `npm run test -- --watch` instead of  `jest --watch `

## Configuring auth0

- Make sure `http://localhost:8080/callback` is an allowed callback URL for your auth0 client.

- Edit `preact.config.js` and update `process.env.AUTH0_DOMAIN` and `process.env.AUTH0_CLIENT_ID` with your auth0 information.