Skip to content

Latest commit

 

History

History
84 lines (73 loc) · 3.97 KB

README.md

File metadata and controls

84 lines (73 loc) · 3.97 KB
Raw

Adocasts

Adocasts Jumpstart

An AdonisJS 6 Authentication Scaffold with TailwindCSS
node ace add @adocasts.com/jumpstart

npm-image license-image

Features

Everything you meed to jumpstart your next AdonisJS 6 project

  • 🪄 Automatically configures TailwindCSS
  • 🔐 Full authentication flow, including remember me
  • 🔏 Forgot password ready to go out-of-the-box, including email
  • 🕵️ Simple profile settings page
  • 👨‍💻 Simple account settings page with change email & delete account forms
  • 🚨 Toast messages to notify your users
  • 🏖️ Handy EdgeJS components and layouts to get you going

Works With

It is recommended to start from the Web Starter Kit as it comes out-of-the-box with most of the AdonisJS core packages we require.

  • 🕸️ Web Starter Kit (recommended)
  • 📏 Slim Starter Kit

Requires

We require the following AdonisJS core packages. If you're missing any, we'll walk you through adding any you're missing during the configuration step!

Prerequisites

  • AdonisJS 6 web/slim project (npm init adonisjs@latest)
  • If @adonisjs/auth is already configured, you must be using the session guard

Getting Started

Adocasts Jumpstart only needs to run once and adds/installs everything needed directly into your project so you have full control to change anything you wish.

node ace add @adocasts.com/jumpstart

Actions Performed

All you need to do is install & configure Adocasts Jumpstart. It'll then:

  1. Walk you through adding any missing AdonisJS core packages
  2. Install the following dependencies directly into your project. Feel free to remove any you don't wish to use
    • TailwindCSS (tailwindcss --dev)
    • Autoprefixer (autoprefixer --dev)
    • EdgeJS Iconify (edge-iconify)
    • Iconify Phosphor (@iconify-json/ph)
    • Iconify SVG Spinners (@iconify-json/svg-spinners)
  3. Fully configure TailwindCSS inside your project
  4. Adds an APP_URL environment variable (useful for email link generating)
  5. Enables HTTP Method Spoofing (allows REST-based routes)
  6. Adds a globals preload file for EdgeJS globals & to configure EdgeJS Iconify
  7. Adds all stub files into your project. This will include:
    • Controllers
    • Models
    • Services
    • Validators
    • Migrations
    • Views -> Components
    • Views -> Emails
    • Views -> Pages
  8. Adds Jumpstart's routes to your routes.ts file
  9. Adds auth methods to your user model
  10. Lastly, you can optionally uninstall @adocasts.com/jumpstart. Once everything is scaffolded, you no longer need it.

After that, be sure to update any new environment variables or configurations that may have been added from missing AdonisJS core packages, boot it up, and visit /jumpstart.