Skip to content

Improve README #214

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

Merged
tchapi merged 2 commits into from
Sep 10, 2025
Merged

Improve README #214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d700e99
Improve README (composer without dev deps; APP_ENV=prod env variable)
EpocDotFr Sep 10, 2025
92f0b69
Explain a bit why APP_ENV=prod is really needed in a prod env
EpocDotFr Sep 10, 2025
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,11 @@ Dependencies
1. Retrieve the dependencies:

```
composer install
composer install --no-dev
```

Remove `--no-dev` if you plan to install Davis locally for e.g. development purposes.

2. At least put the correct credentials to your database (driver and url) in your `.env.local` file so you can easily create the necessary tables.

3. Run the migrations to create all the necessary tables:
Expand All @@ -93,6 +95,10 @@ Create your own `.env.local` file to change the necessary variables, if you plan
>
> If your installation is behind a web server like Apache or Nginx, you can setup the env vars directly in your Apache or Nginx configuration (see below). Skip this part in this case.

> [!CAUTION]
>
> In a production environnement, the `APP_ENV` variable MUST be set to `prod` to prevent leaking sensitive data.

**a. The database driver and url** (_you should already have it configured since you created the database previously_)

```shell
Expand Down