Forest Project

Forest project is opinionated API-based kit based on Nette Framework + Apitte and many useful packages by @f3l1x.

Why forest? Because we are building (fo)REST API.

🕹 f3l1x.io | 💻 f3l1x | 🐦 @xf3l1x

composer create-project -s dev planette/forest-project acme

Goal

Main goal is to provide best prepared API starter-kit project for Nette-Apitte developers.

Focused on:

You can try it out yourself either by running it with docker, or more easily with docker-compose.

At first, use composer to install this project.

composer create-project planette/forest-project

After that, you have to setup Postgres >= 10 database. You can start it manually or use docker image postgres:10.
```
docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=forest -e POSTGRES_USER=forest postgres:10
```
Or use make task, make loc-postgres.

Custom configuration file is located at app/config/config.local.neon. Edit it if you want.

Default configuration should look like:

# Host Config
parameters:

    # Database
    database:
        host: localhost
        dbname: forest
        user: forest
        password: forest

Ok database is now running and application is configured to connect to it. Let's create initial data.

Run NETTE_DEBUG=1 bin/console migrations:migrate to create tables. Run NETTE_DEBUG=1 bin/console doctrine:fixtures:load --append to create first user(s).

Or via task make build.
Start your devstack or use PHP local development server.

You can start PHP server by running php -S localhost:8000 -t www or use prepared make task make loc-api.
Open http://localhost and enjoy!

Take a look at:
- [GET] http://localhost:8000/api/public/v1/openapi/meta (Swagger format)
- [GET] http://localhost:8000/api/v1/users
- [GET] http://localhost:8000/api/v1/users?_access_token=admin
- [GET] http://localhost:8000/api/v1/users/1?_access_token=admin
- [GET] http://localhost:8000/api/v1/users/999?_access_token=admin
- [GET] http://localhost:8000/api/v1/users/email?email=admin@admin.cz&_access_token=admin
- [POST] http://localhost:8000/api/v1/users/create

At first, use composer to install this project.

composer create-project planette/forest-project

Modify app/config/config.local.neon and set host to database

Default configuration should look like this:

# Host Config
parameters:

    # Database
    database:
        host: database
        dbname: forest
        user: forest
        password: forest

Here is a list of all features you can find in this project.