starter-pack

(β˜… 209)

Combines React (ft. hooks), Redux, Redux-saga and TypeScript with Auth0 as a starting point for modern web apps with solid authentication

  • .eslintrc.js
  • .gitignore
  • .nvmrc
  • buildspec.yml
  • Dockerfile
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • README.md
  • server.ts
  • tsconfig-webpack.json
  • tsconfig.json
  • tslint.json
  • webpack.config.ts
  • webpack.prod.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/jch254/starter-pack

Downloads the entire project code from GitHub to your computer.

cd starter-pack

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t starter-pack .

Builds a runnable image based on the Dockerfile.

docker run \

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install --frozen-lockfile

Downloads and installs the libraries listed in package.json.

pnpm run dev

Starts the development/run server.

AUTH0_CLIENT_ID=abc AUTH0_DOMAIN=your-tenant.eu.auth0.com pnpm run dev

Starts the development/run server.

pnpm run build

Builds optimized production files.

pnpm run prod

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation