Skip to content

Docs: unify skeleton README #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ohmyfelix wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: unify skeleton README #409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
008f467
Docs: unify skeleton README
ohmyfelix Aug 15, 2026
d5eec22
Docs: verify starter onboarding
ohmyfelix Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,12 @@ Create project using composer.

```bash
composer create-project -s dev contributte/starter-skeleton acme
cd acme
make init
make setup
```

Now you have application installed. It's time to run it.
Composer installs the PHP dependencies while creating the project. `make init` creates the ignored `config/local.neon` file from `config/local.neon.example`; place machine- and environment-specific configuration there. `make setup` prepares the writable runtime directories.

## Startup

Expand All @@ -53,7 +56,20 @@ make dev
# php -S 0.0.0.0:8000 -t www
```

Then visit [http://localhost:8000](http://localhost:8000) in your browser.
Then visit [http://localhost:8000](http://localhost:8000). A successful first page displays **Hello!**. Follow **To contact form**, enter `nette`, submit the form, and verify the **Systems OK** success message.

## Commands

```bash
make qa # coding standard and static analysis
make tests # run Tester tests
make csf # fix coding style
make clean # remove temporary files and logs
```

## Configuration

Shared application configuration is in `config/config.neon`; local overrides belong in `config/local.neon` after running `make init`.

## Development

Expand Down