https://github.com/promcms/promcms
PHP projects made easy
https://github.com/promcms/promcms
cms php
Last synced: over 1 year ago
JSON representation
PHP projects made easy
- Host: GitHub
- URL: https://github.com/promcms/promcms
- Owner: PromCMS
- Created: 2022-06-26T07:59:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T17:20:25.000Z (over 1 year ago)
- Last Synced: 2025-03-08T01:34:29.081Z (over 1 year ago)
- Topics: cms, php
- Language: TypeScript
- Homepage:
- Size: 3.55 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> ⚠️ Please be aware that this tool is under active development and is still not suitable for normal use. All help or interest is welcome! 🚀
# PromCMS
Welcome to PromCMS project. This project focuses on making smaller PHP projects simpler and faster to build.
## How it works 🤔
The general idea is that you provide config file with definitions on how should your PHP app should look like (defining models, app name, etc...) and just create a whole project from that with predefined workflow (webpack/vite, twig, slim php...)
This will boost your performance a lot and you can focus on what really matters - producing actual visible stuff 😉
## Quick Start
1. Create a root of your desired project
```bash
mkdir test-project && cd ./test-project
```
5. Generate project with one command in current directory (still in the same folder as your config)
```bash
npx @prom-cms/cli project create
```
6. Now your project is prepared, ready to go and you can start your dev server 🎉
```bash
pnpm run dev
```
7. You can now go to [http://localhost:3000](http://localhost:3000) 🤯
> You may also find useful to seed your database with random data with `npx @prom-cms/cli seed-database` 😳
## Guides
1. [Get Started](./docs/guides/get-started.md)
2. [Adding Routes](./docs/guides/adding-routes.md)
## More in Depth 😲
- [Admin Package](./packages/admin/README.md) - All source files of admin portal
- [Api Client Package](./packages/api-client/README.md)
- [CLI Package](./packages/cli/README.md) - Know your CLI for easier management of PromCMS projects
- [Config Package](./packages/config/README.md) - All internal configuration for typescript, prettier, etc...
- [In Page Editor Package](./packages/in-page-editor/README.md)
- [Schema Package](./packages/schema/README.md) - Know your powerful schema and use it to the fullest!
- [Shared Package](./packages/shared/README.md) - Internal helpers
- [Vite Plugin Package](./packages/vite-plugin/README.md) - Source files for vite plugin that manages development of PromCMS projects