Skip to content
This repository was archived by the owner on Feb 21, 2022. It is now read-only.

Commit a998884

Browse files
author
Milan Lukac
committed
Update .env file documentation
1 parent dfec181 commit a998884

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

.env.example

-4
This file was deleted.

README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ The Zoo also provides analytics about how dependency usage and its versions evol
3333

3434
- Create a database: `$ make migrate`
3535
- Create a superuser: `$ make superuser`
36-
- Create `.env` file based on `.env.example`
37-
- Use gitlab/github tokens with read permissions
38-
- Specify gitlab url if applicable
36+
- Create `.env` file as documented below
3937

4038
### How to run
4139

@@ -61,6 +59,20 @@ Access web locally:
6159
Check `Makefile` for shell commands if you want to run them with modified
6260
parameters.
6361

62+
### Local .env file
63+
64+
Local `.env` file is required to run the application, a basic example of such file contains the following:
65+
66+
```
67+
ZOO_DEBUG=1
68+
ZOO_GITHUB_TOKEN=...
69+
ZOO_GITLAB_TOKEN=...
70+
ZOO_GITLAB_URL=https://gitlab.com
71+
```
72+
73+
Version control tokens only need read access to repositories.
74+
75+
6476
## Testing
6577

6678
Run all tests: `$ make test`

0 commit comments

Comments
 (0)