reactnest-boilerplate

(★ 96)

🗼A starter project template with (Ngnix, ReactJS, Redux, Redux Thunk, React Router, NestJS, TypeORM, PostgreSQL, Docker, PM2) + (Code Style, Conventional Changelog with Commitlint, Husky, Git CZ)

  • .editorconfig
  • .gitignore
  • .nvmrc
  • commitlint.config.js
  • docker-compose.dev.example
  • docker-compose.prod.example
  • entrypoint-dev.sh
  • entrypoint-prod.sh
  • LICENSE
  • package-lock.json
  • package.json
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/gabriel-roque/reactnest-boilerplate

Downloads the entire project code from GitHub to your computer.

cd reactnest-boilerplate

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ git clone https://github.com/gabriel-roque/react-donis-docker-starter

Type this command into your terminal and run it.

$ cd react-donis-docker-starter

Type this command into your terminal and run it.

$ docker-compose up -d

Runs the command against the services defined in the compose file.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm run typeorm:create

Type this command into your terminal and run it.

$ npm run typeorm:migrate

Type this command into your terminal and run it.

$ npm run typeorm:run

Type this command into your terminal and run it.

$ cd web-app && npm start

Starts the development/run server.

$ cd api && npm run start:dev

Starts the development/run server.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation