Getting Started

Welcome to the documentation for Nzoni Boilerplate! This guide will walk you through the setup, configuration, and usage of Nzoni, a robust SaaS boilerplate designed to accelerate your web application

Make sure you have node v18+ and npm v10+

Download repositories

Once you've purchased Nzoni, your github email account will be added to the related projects. Make sure you're already connected to github on your cli terminal or use Github Personal access token.

Download Angular repository

git clone https://github.com/nzoni-app/nz-angular.git

Download Nest.js repository

git clone https://github.com/nzoni-app/nz-nestjs.git

Download Node.js repository

git clone https://github.com/nzoni-app/nz-nodejs-mongodb.git

Installation

Install Node.js (if you haven't already)

If you haven't installed Node.js yet, you can follow the instructions here.

Install Node Modules for Angular project

Navigate to the downloaded Angular project repostiory:

cd nz-angular
npm install

Install Node Modules for Nest.js project

Navigate to the downloaded Nest.js project repostiory:

cd nz-nestjs
npm install

Configure Environment Variables

Nest.js environnement

Nest.js supports environment variables out of the box. You can set defaults in .env (for all environments), .env.development (for development), and .env.production (for production).

By default, there is the .env.example file. Rename it to .env modify variables

ENV=developpement # OR production OR stagging

# Typeorm configuration for migration
TYPEORM_CONNECTION=postgres
TYPEORM_HOST=localhost
TYPEORM_PORT=5432
TYPEORM_USERNAME=
TYPEORM_PASSWORD=
TYPEORM_DATABASE=
TYPEORM_SYNCHRONIZE=false
TYPEORM_ENTITIES=src/**/*.entity.ts
TYPEORM_MIGRATIONS_TABLE_NAME=migrations
TYPEORM_MIGRATIONS_DIR=migrations
TYPEORM_MIGRATIONS=migrations/*.ts

# MAILING
SMTP_HOST=
SMTP_PORT=
SMTP_SECURE=false
SMTP_AUTH=
SMTP_PASSWORD=
SMTP_FROM='"Support name" <[email protected]>'
MODERATION_MAIL=
# Logs
APP_DEBUG=true
JOB_ERROR_LOG_PATH='./'
DEFAULT_LOG_PATH='./logs'

# JWT
JWT_SECRET=A/iQ2KX0auTZZBwsbPEGC8H3a78HiiL23WD4S+QAoEq34LdeJ9aPrgpHdkkTvBzJ46K2JkM4apkg414erD3S+qLvwiYk3DTorANbbkA+54tVJsXrSGsaUjGifR31OaRK98aDVgICvl60Nymo3+I6527+BOkZalZsbCPzsJ7nALyTNu9Ud2FsvfK0WpAQVOf4teoHT4R/7E7ENChmgHRvI/TWumKfWcyr//Q7b9bLipFivk0EDzkpApdaEsClxE7JjT33aZhMvtuvLn5mQF3L5/ubGs5ZZy+nk4AyhR1DBTYjBYzKoamf94JW3BPobg5heH8gGnNoA+5l3WOJA7uvzw==
JWT_EXPIRATION=192h # 3 days

# FONT_END_URL
FRONT_END_URL=

#GOOGLE
GOOGLE_CLIENT_ID=
GOOGLE_APPLICATION_CREDENTIALS=google-service.json

#STRIPE
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=

#TRIAL PERIOD IF EXIST
TRIAL_DAYS=

Angular Environnement

Edit src/environments/environnement.ts

export const environment = {
        // GOOGLE AUTH
        google_client_id:
        // GOOGLE TAG for ANALYTICS
        google_tag_id:
}

Create Tables

To set up the required tables, navigate to the downloaded Nest.js project repostiory and run the following command:

npx ts-node ./node_modules/.bin/typeorm  migration:run -d ./datasource.ts

Run

Angular

To start Angular project, simply run:

ng serve

Angular instance is now running at http://localhost:4200/.

Nest.js

To start Nest.js project, simply run:

npm run start:dev

Nest.js instance is now running at http://localhost:3000/.

Node.js/MongoDB

Run the following command to start the server:

npm run start

Node.js instance is now running at http://localhost:3000/.

Congratulations! Your Nzoni project is now running!

NextAngular

Last updated 1 year ago