Skip to content

Getting started

Template essential is basic template that every application will need this, like authentication, email delivery, API documentation, frontend security, and SPA. This template is crafted to be as generic as possible, ensuring that users will find it familiar and easy to use.

Pre-requisites

Installation

Each project have several folder like backend and frontend, run yarn install for each folder and the root folder too

bash
yarn install
yarn --cwd apps/backend install 
yarn --cwd apps/admin install

Setup Configuration File

Each folder have their own .env file. You can copy the .env.example file and rename it to .env for each folder.

Run the migration

We are using Prisma Migration, so run these command inside Backend folder.

bash
cd apps/backend
npx prisma migrate dev

Run the application

Run the backend and frontend application

bash
yarn dev

Access the application

Open your browser and access http://localhost:5199 to see the application, and https://localhost:4000/docs to see the API documentation.