yii2-angular-boilerplate

(β˜… 226)

Yii2 REST API + Angular 12 Boilerplate (Frontend/Backend)

  • .gitignore
  • .gitlab-ci.yml
  • docker-compose.actions.yml
  • docker-compose.yml
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/chrisleekr/yii2-angular-boilerplate

Downloads the entire project code from GitHub to your computer.

cd yii2-angular-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.
$ docker-compose up -d

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

docker exec -it api /bin/sh

Type this command into your terminal and run it.

docker exec api composer run sniff

Type this command into your terminal and run it.

docker exec api composer run test:unit

Type this command into your terminal and run it.

docker logs backend --follow

Type this command into your terminal and run it.

βœ… 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 test

Type this command into your terminal and run it.

$ npm run e2e

Type this command into your terminal and run it.

βœ… 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.

4. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
docker exec api composer run sniff

Type this command into your terminal and run it.

docker exec api composer run test:unit

Type this command into your terminal and run it.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation