Janis-Rullis-IT/pr1-symfony5-api

Dockerized Symfony 5 API

Let customers order Your custom shirts and mugs!

Create a product and set it's cost and title. After that customers from all the world can order them ^*.

FIRST TIME? HOW TO SET THIS UP?

1. Install docker

Docker is a virtual environment with all the required software included. See all other benefits.

2. Provide Your environment values

• Copy the .env.example to .env and fill FILL_THIS values in it.

3. Execute the setup.sh script ^*

It will download, install and prepare all the required software.

./setup.sh

4. Add these to Your hosts file

This transletes the machines address to the domain-name.

172.70.2.11     api.pr1.local
172.70.2.14     pma.pr1.local

ALREADY SET-UP?

• ./start.sh - Start containers once the setup has been done.
• ./connect.sh - Connect to the main container.
• ./test.sh - Execute PHPUnit tests.
• ./lint.sh - Check and format the code.

Documentation

This describes all the available functions and the way how to call them.

• http://api.pr1.local/doc

Wiki

• https://github.com/janis-rullis/pr1/wiki

Have questions? Found a bug?

Please, submit an issue here.

Honorable mentions

• Thanks to @lauris-printify / homework-v3 for the main codebase (till 3d0a) 👍 🥇 🍻
• lara5-vue2-api for the Docker structure.

Notes

• ^* currently from US-based companies.
• ^** shell.sh is just a helper that saves You from executing few commands Yourself. In case, if You can't execute it (on Windows) or there is some trouble, then You can set it up manually as every other Docker + Symfony project.