https://github.com/pferreirafabricio/php-template-api

🐘 A simple PHP API structure for use in quick and small projects without frameworks
https://github.com/pferreirafabricio/php-template-api

docker mysql nginx php php-fpm php8 rest-api

Last synced: about 2 months ago
JSON representation

🐘 A simple PHP API structure for use in quick and small projects without frameworks

• Host: GitHub
• URL: https://github.com/pferreirafabricio/php-template-api
• Owner: pferreirafabricio
• License: mit
• Created: 2021-04-27T00:20:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T17:01:38.000Z (2 months ago)
• Last Synced: 2024-11-06T18:18:12.421Z (2 months ago)
• Topics: docker, mysql, nginx, php, php-fpm, php8, rest-api
• Language: PHP
• Homepage:
• Size: 93.8 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  PHP API structure 🐘





  

  



## :open_book: About 

This project is a simple PHP API structure for use in quick and small projects without frameworks.





## :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-templateApi.git`

 2. Enter in the project's folder: `cd php-templateApi`

 3. Copy the .env.example file to .env: `cp .env.example .env`

 4. Change the .env file with your configurations

 5. Build the app image: `docker compose build app`

 6. Start the containers: `docker compose up -d`

 7. Install project's dependencies: `docker compose exec app composer update`

 8. 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.