Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrykbaszak/api-skeleton
A minimal project that allows you to quickly create a new api project based on Symfony using useful tools: swagger, standard-version, php-cs-fixer, phpstan, phpunit, docker, xdebug and my own starting script. It is ready to support debugging with Visual Studio Code - just look into .env.local ;).
https://github.com/patrykbaszak/api-skeleton
api skeleton symfony
Last synced: 9 days ago
JSON representation
A minimal project that allows you to quickly create a new api project based on Symfony using useful tools: swagger, standard-version, php-cs-fixer, phpstan, phpunit, docker, xdebug and my own starting script. It is ready to support debugging with Visual Studio Code - just look into .env.local ;).
- Host: GitHub
- URL: https://github.com/patrykbaszak/api-skeleton
- Owner: patrykbaszak
- License: mit
- Created: 2023-11-18T09:29:43.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-03-09T22:19:25.000Z (10 months ago)
- Last Synced: 2024-12-14T02:15:23.960Z (10 days ago)
- Topics: api, skeleton, symfony
- Language: PHP
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# API Skeleton #
A minimal project that allows you to quickly create a new api project based on Symfony using useful tools: `swagger`, `standard-version`, `php-cs-fixer`, `phpstan`, `phpunit`, `docker`, `xdebug` and my own `starting script`. It is ready to support debugging with Visual Studio Code - just look into `.env.local` ;).
### WHY?
https://github.com/patrykbaszak/skeleton#why
### How to start
Create directory for Your project, get in (`cd {Your directory}`) and run command:
```sh
composer create-project pbaszak/api-skeleton . --no-interaction
```
(Everytime) Start local environment using this command:
```sh
bash start.sh
```
and voila! Your local environment is ready to development api app with useful tools.
**Check `http://localhost:8080/api/doc`!**
### How to use **Standard Version**
If You don't have node_modules directory run:
```sh
npm install
```
First release:
```sh
npm run version:first-release
```
`Major`, `Minor`, `Patch` version update:
```sh
npm run version:major
# or
npm run version:minor
# or
npm run version:patch
```
Push tags:
```sh
npm run version:release
# or
npm run release
```
Check `package.json` for understand what commands do.
### How to use **PHPStan**
Main command:
```bash
docker exec php composer code:analyse
```
but, if You need to add errors to ignored:
```bash
docker exec php composer code:analyse:b
```
### How to use **PHP CS Fixer**
```bash
docker exec php composer code:fix
```
### How to use **XDebug** in **Visual Studio Code**
Create new file in Your project: `.vscode/launch.json`
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Listen for xDebug",
"type": "php",
"request": "launch",
"port": 5902,
"hostname": "0.0.0.0",
"pathMappings": {
"/app/": "${workspaceRoot}"
}
}
]
}
```
Uncomment environments in `.env.local`:
```env
XDEBUG_MODE=develop,debug
XDEBUG_CONFIG=" client_port=5902 idekey=VSCODE client_host=host.docker.internal discover_client_host=0 start_with_request=yes"
```
Type `Ctrl + Shift + D` and run `Listen for xDebug`.