https://github.com/pferreirafabricio/libertatis-api

🦜 A simple RESTFul API for the Libertatis project, made without any framework, using docker and PHP 8
https://github.com/pferreirafabricio/libertatis-api

docker game-api mysql nginx php php-fpm php8 rest-api unity

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/pferreirafabricio/libertatis-api
• Owner: pferreirafabricio
• License: mit
• Created: 2021-04-30T00:22:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-15T18:57:33.000Z (over 2 years ago)
• Last Synced: 2024-05-28T14:08:45.784Z (8 months ago)
• Topics: docker, game-api, mysql, nginx, php, php-fpm, php8, rest-api, unity
• Language: PHP
• Homepage:
• Size: 130 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  Seeking freedom ☠️





  

  



## :open_book: About 

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

> Check the Unity game [here](https://github.com/coetus-jd/unity-pirateCave)

## :rosette: API Routes

```

GET - players/

GET - players/{nick}

POST - players/

PUT - players/

GET - history/{nick}

PUT - history/

```

## :bricks: This project was built with: 

- [PHP](https://www.php.net/)

- [CoffeCode Router](https://github.com/robsonvleite/router)

- [MySQL](https://www.mysql.com/)

- [Nginx](https://www.nginx.com/)

- [Docker](https://www.docker.com/)

## :running_man: 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`

 6. Install project's dependencies: `docker-compose exec app composer install`

 7. Finally you can visit [`127.0.0.1:8000`](http://127.0.0.1:8000/) from your browser 😃

 

## :recycle: 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```

 

## :page_with_curl:	License

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