RPGda0 Starter CLI

A simple, flexible CLI for bootstraping full-stack web applications using react, postgreSQL, go, docker, auth0.
This CLI provides a boilerplate setup for quickly starting your next project with these technologies.
It includes ready-to-use configurations for backend & frontend integration, database setup, user authentication, & docker.

• R - react
• P - postgreSQL
• G - golang
• d - docker
• a0 - auth0

Prerequisites

• Docker
• Node
• Auth0 Account with required values in .env
• Git

Installation steps

Installation using .tar.gz in Linux and Mac

• Download the suitable .tar.gz
• Move the download to the preffered installation directory.
• Run following command to extract and make the executable.

tar xf RPGda0-starter-cli_Linux_x86_64.tar.gz && sudo chmod +x ./RPGda0-starter-cli

• Export path of directory in .profile and source the .profile.

export PATH=$PATH:</path/to/installation/directory>

Installation using .zip in Windows

• Download the suitable .zip
• Move the download to the preffered installation directory.
• extract the zip
• Export path of directory in Environment variables.

How to run the CLI

• After the successfull installation just run following command to generate the starter project in the preferred directory.

RPGda0-starter-cli

• Fill all the required information to generate the .env

Steps to Run DB, API and Client

Steps to run PSQL DB

• Open new terminal
• In root directory, run database container.

docker compose up starter_db

Steps to run Migration

• Open new terminal
• Uncomment following line in docker-compose.yml

# command: go run ./cmd/migrate

• Run following command.

docker compose up starter_api

Steps to run API Server

• Open new terminal
• Comment back following line in docker-compose.yml

command: go run ./cmd/migrate

• Run following command to start api server.

docker compose up starter_api

Steps to run Web Client

• Open new terminal
• Change directory to web.
• Install Dependencies.

npm i

• run client.

npm run start

Running PORTS

• API will be running at port 9090
• Web app will be running at port 5173