amunchet / vue3-auth0-quickstart

Vue3 + Auth0 Scaffold Project Template

vue-auth0-quickstart

Quickstart scaffold template for Vue + Auth0

Summary

This quickstart template creates a basic Vue application with Auth0 already implemented. It will also run npm update on creation.

Requirements

Make sure that Docker and python are installed on the base. Docker-compose is created by default, but not required.

Installation

0. Clone this repository git clone https://github.com/amunchet/vue-auth0-quickstart.git
1. cd vue-auth0-quickstart
2. ./setup.py (or python setup.py)
3. Follow the prompts.
4. Enjoy.

Usage

This is meant to be used as a starting point for a larger Vue project. You will likely change the docker configuration, endpoint, and packages.

The two key files are auth.js and authService.js - they are they keys to intergation with Auth0.

The file project_name/entrypoint.sh is the Docker entrypoint. Remove npm update or the Vue UI server here.

Typical Next Steps

Next steps in using the quickstart with the rest of your project could be something like this (assuming you cloned vue-auth0-quickstart into your larger project):

1. cat docker-compose.yml >> ../docker-compose.yml # You will need to edit docker-compose.yml after this
2. mv frontend ..
3. cd .. && rm -rf vue-auth0-quickstart