Skip to content

Commit

Permalink
fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nik2208 committed Oct 12, 2023
1 parent 8ee5610 commit a37aee3
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ PHP_CRUD_API_DEBUG=true
```

Then run `docker compose up -d`. Enjoy!🎉🚀
Refer to [PHP-CRUD-API](https://github.com/mevdschee/php-crud-api) for further customizations.

## REQUIREMENTS:
- Any host runnign [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/).

In case your running your instance on localhost and your selected port is 8080
**Your `tests` table will be available at**
http://127.0.0.1:8080/records/tests (no need of explicit api.php)[^1]
**Your PHPMYADMIN instance will be available at**
https://127.0.0.1:8080/phpmyadmin/
**Your MYSQL ADMIN instance will be available at**
https://127.0.0.1:8080/dbadmin/
**Your SWAGGER instance will be available at**
https://127.0.0.1:8080/swagger/

Expand All @@ -60,8 +61,8 @@ Change ip and port accordingly if host and port differ.

**Your `tests` table will be available at**
https://api.example.com/records/tests (no need of explicit api.php)[^1]
**Your PHPMYADMIN instance will be available at**
https://api.example.com/phpmyadmin/
**Your MYSQL ADMIN instance will be available at**
https://api.example.com/dbadmin/
**Your SWAGGER instance will be available at**
https://api.example.com/swagger/

Expand Down

0 comments on commit a37aee3

Please sign in to comment.