coetus-jd / libertatis-api

🦜 A simple RESTFul API for the Libertatis project, made without framework, using docker and PHP 8

Seeking freedom ☠️

📖 About

This project is a a simple RESTful API for the Pirate Cave project.

Check the Unity game here

🏵️ API Routes

GET - players/
GET - players/{nick}
POST - players/
PUT - players/

GET - history/{nick}
PUT - history/

🧱 This project was built with:

• PHP
• CoffeCode Router
• MySQL
• Nginx
• Docker

🏃‍♂️ Installing and Running

1. Clone this repository git clone https://github.com/pferreirafabricio/php-pirateCave.git;
2. Enter in the project's folder: cd php-pirateCave
3. Build the app image: docker-compose build app
4. Start the containers: docker-compose up -d
5. Install project's dependencies: docker-compose exec app composer install
6. Finally you can visit 127.0.0.1:8000 from your browser 😃

♻️ Contribute

1. Fork this repository;
2. Create a branch with your feature: git checkout -b my-feature
3. Commit your changes: git commit -m 'feat: My new feature'
4. Push your branch: git push origin my-feature

📃 License

This project is under the MIT license. Take a look at the LICENSE file for more details.