Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/germondai/php-starter
Simple PHP Starter with RESTful API, Doctrine, JWT, SEO and more...
https://github.com/germondai/php-starter
api db doctrine jquery jwt migrations mysql php rest-api seo starter tailwindcss
Last synced: about 1 month ago
JSON representation
Simple PHP Starter with RESTful API, Doctrine, JWT, SEO and more...
- Host: GitHub
- URL: https://github.com/germondai/php-starter
- Owner: germondai
- License: mit
- Created: 2024-04-30T19:10:12.000Z (8 months ago)
- Default Branch: dev
- Last Pushed: 2024-06-04T21:44:12.000Z (7 months ago)
- Last Synced: 2024-06-05T12:27:05.132Z (7 months ago)
- Topics: api, db, doctrine, jquery, jwt, migrations, mysql, php, rest-api, seo, starter, tailwindcss
- Language: PHP
- Homepage: https://api.germondai.com
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
PHP Starter
This project **simplifies** starting new **PHP** projects. It's perfect if you want to **skip setting up basics** and **get coding quickly**. It **doesn't rely** on any **PHP framework**, making **configuration** easy and offering great **features**.
## ⚡️ Features
**Overview**
- Own REST API System
- Routing
- Auth
- Security
- Routing
- File and Dir access
- Custom Utils
- Helper
- Page Helper
- Database
- Doctrine
- JSON Web Tokens
- Well Organized Structure
- Nette
- Database Explorer
- Tracy
- Doctrine
- ORM
- DBAL
- Entities
- Migrations
- Environment (.env)
## 🧬 Structure
**api/** - accessible on /api/_model_/_action_, (models and entities)\
**bin/** - Console for Doctrine\
**migrations/** - Doctrine DB Migrations\
**public/** - the main directory accessible from outside\
**src/** - contains includes, utils and dev assets\
**temp/** - Nette DB Temp Storage\
## 🧠 Technologies
- PHP
- TailwindCSS
- jQuery
- Doctrine
- Nette DB
- JSON Web Tokens (JWT)
## 🛠️ Installation Instructions
Requirements
- 👨💻 Composer
- 📦 Node Package Manager (pnpm - recommended)
**Install dependencies**
```bash
composer install
pnpm install
```
**Setup .env**
Fill in placeholders for database credentials in the .env file
```bash
# to dupe example.env as .env
cp example.env .env
```
## 🎨 Tailwind CSS Guide
It's main css is stored in "_src/assets/css/tailwind.css_"\
and its being converted into "_public/assets/css/style.css_"
### Conversion / Watch
```bash
# To convert it, you have to run
pnpm run watch:css
# or simply run start (does the same)
pnpm run start
```
## 📚 Doctrine Guide
The Doctrine console is in "_bin/console_"\
EntityManager config location "_src/Utils/Doctrine.php_"\
Base migrations config, which is in root "_migrations.php_"\
And migration files are stored in "_migrations/_"
### Console
```bash
# To run doctrine console
php bin/console ...
# if you need commands list
php bin/console list
```
---
Made with ❤️ by
@germondai