Skip to content

Commit

Permalink
Readme++
Browse files Browse the repository at this point in the history
  • Loading branch information
f3l1x committed Jul 3, 2023
1 parent 08ed3bf commit f512c9e
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact

## Goal

Main goal is to provide easy-to-use starter-kit project for Nette developers.
Main goal is to provide Doctrine starter-kit for Nette developers.

## Demo

Expand All @@ -36,44 +36,40 @@ https://examples.contributte.org/doctrine-skeleton/

You will need `PHP 8.1+` and [Composer](https://getcomposer.org/).

Create project using composer.
1. Clone project using Git.

```bash
composer create-project -s dev contributte/doctrine-skeleton acme
git clone [email protected]:contributte/doctrine-skeleton.git acme
```

Now you have application installed. It's time to run it.
2. Install PHP dependencies.

```bash
make install
```

## Startup

The easiest way is to use php built-in web server.

```bash
# make dev
php -S 0.0.0.0:8000 -t www
make dev
# php -S 0.0.0.0:8000 -t www
```

Then visit [http://localhost:8000](http://localhost:8000) in your browser.

## Backend

It's based on [Contributte](https://contributte.org/) packages.

- [`contributte/application`](https://github.com/contributte/application)
- [`contributte/bootstrap`](https://github.com/contributte/bootstrap)
- [`contributte/di`](https://github.com/contributte/di)
- [`contributte/forms`](https://github.com/contributte/forms)
- [`contributte/http`](https://github.com/contributte/http)
- [`contributte/utils`](https://github.com/contributte/utils)
- [`contributte/latte`](https://github.com/contributte/latte)
- [`contributte/tracy`](https://github.com/contributte/tracy)
It's based on packages from [Contributte](https://contributte.org/) family.

- [`contributte/doctrine-dbal`](https://github.com/contributte/doctrine-dbal)
- [`contributte/doctrine-orm`](https://github.com/contributte/doctrine-orm)
- [`contributte/doctrine-annotations`](https://github.com/contributte/doctrine-annotations)
- [`contributte/doctrine-cache`](https://github.com/contributte/doctrine-cache)
- [`contributte/doctrine-migrations`](https://github.com/contributte/doctrine-migrations)
- [`contributte/doctrine-fixtures`](https://github.com/contributte/doctrine-fixtures)
- [`contributte/doctrine-extra`](https://github.com/contributte/doctrine-extra)

## Development

Expand Down

0 comments on commit f512c9e

Please sign in to comment.