Usage

After installing kickstart, start using it. It has a few usefull commands that helps you to generate template easily.

# How to generate new template

To generate new template simply use new command with your project name.

$ kickstart new project-name

This command will clone github repository of kickstart_js and installs node modules for each client and server directories.

$ cd project-name

Then enter to your project directory.

to run client side of your template.

$ cd client

and run it

$ npm run dev

before testing client don't forget to run server

# Usage of Server

To use server site of your new template, you have to fullfill .env file, for github, google and email secret informations

env


# General App Config

DATABASE_URL="postgresql://db_user:password@localhost:5432/kickstart_js"
FRONT_ORIGIN="http://localhost:3000" # frontend link
PORT=8080
JWT_SECRET="a-string-secret-at-least-256-bits-long"

# Magic Link Email Auth

MAILER_USER="no-reply@example.uz"
MAILER_PASS="Your email app password"

# Google OAuth

GITHUB_CLIENT_ID="Your github client id"
GITHUB_CLIENT_SECRET="Your github client secret"

# Google OAuth

GOOGLE_CLIENT_ID="Your google client id"
GOOGLE_CLIENT_SECRET="Your google client secret"


# General App Config

DATABASE_URL="postgresql://db_user:password@localhost:5432/kickstart_js"
FRONT_ORIGIN="http://localhost:3000" # frontend link
PORT=8080
JWT_SECRET="a-string-secret-at-least-256-bits-long"

# Magic Link Email Auth

MAILER_USER="no-reply@example.uz"
MAILER_PASS="Your email app password"

# Google OAuth

GITHUB_CLIENT_ID="Your github client id"
GITHUB_CLIENT_SECRET="Your github client secret"

# Google OAuth

GOOGLE_CLIENT_ID="Your google client id"
GOOGLE_CLIENT_SECRET="Your google client secret"

If you want to change PORT of server you should change it from api config from client /app/api/api.config.ts

# Final

That is it, now you have ton of pre-built configuration and modern styled authentication with Magic link, Google and Github providers

Now you can focus on your project instead of cofigurations

Also you can check information about pachage from command

$ kickstart info

Documantation of frameworks you can find from Nest Docs and Next Docs.

# ✨ Happy Coding!

The end, Home page