How to Install and Run the project on Docker

1. Clone the repo

   git clone https://github.com/ledhcg/rikedu-api.git

2. Go to folder

   cd rikedu-api

3. Build and run with docker

   (sudo) docker-compose --env-file .env.docker up --build

4. Running Seeders

   (sudo) docker-compose exec api php artisan migrate:fresh --seed

5. You can use:

• [API] on 127.0.0.1:80 or localhost:80

How to Install and Run the project on local

1. Clone the repo

   git clone https://github.com/ledhcg/rikedu-api.git

2. Go to folder

   cd rikedu-api/src

3. Copy ".env.example" to ".env"

4. Install package

   composer install

5. Generate key

   php artisan key:generate

6. Link storage

   php artisan storage:link

7. Running Seeders

• Active XAMPP Apache and MySQL

  php artisan migrate:fresh --seed

8. You can use:

   php artisan serve

• [API] on 127.0.0.1:8000 or localhost:8000

How to use Prettier

Using Command Palette (CMD/CTRL + Shift + P)

CMD/CTRL + Shift + P -> Format Document

OR

1. Select the text you want to Prettify
2. CMD/CTRL + Shift + P -> Format Selection

Install dev package

npm install

Outside the Laravel project

• docker-compose.yaml
• Dockerfile.api
• .env.docker
• package.json
• README.md
• .prettierrc.json

Config file .gitignore (If reinstall Laravel project in this directory)

• Add lines:

/node_modules
/.fleet
/.idea
/.vscode
# ignore lock file
package-lock.json
# docker
/mysql

Config file .env (If reinstall Laravel project in this directory)

• Add lines:

PROJECT_NAME=RIKEDU

MYSQL_DATABASE=rikedu
MYSQL_USER=rikedu
MYSQL_PASSWORD=secret
MYSQL_ROOT_PASSWORD=secret

PMA_HOST=db
PMA_USER=root
PMA_PASSWORD=secret

Documentation

• Open the Postman app and select the collection "RIKEDU".
• Click on the "..." button next to the collection name and select "View Documentation".
• The documentation will be displayed in a new tab in the Postman app.