Skip to content

Commit

Permalink
Add a note about .env file in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itayox committed Jul 23, 2023
1 parent 484842b commit b92205c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ CODETOTAL_WS_HOST=127.0.0.1
DEBUG_MODULES=actions,megalinter,stores,transport

# FRONTEND
UPLOAD_FILE_LIMIT_BYTES=10000000
UPLOAD_FILE_LIMIT_BYTES=10000000 # 10MB

23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,29 @@
- `npm test` run all unit tests

## Config
- Backend config `packages/backend/src/config.json`
- Fronend config `packages/app/src/config.json`

Add a `.env` file in the root of the project.

```
# MEGALINTER
MEGALINTER_ANALYSIS_URL=http://127.0.0.1:8000/analysis
MEGALINTER_UPLOAD_URL=http://127.0.0.1:8000/upload-file
MEGALINTER_REDIS_URL=redis://127.0.0.1:6379
MEGALINTER_REDIS_CHANNEL=megalinter:pubsub:<request-id>
# BACKEND
CODETOTAL_HTTP_PORT=8081
CODETOTAL_HTTP_HOST=127.0.0.1
CODETOTAL_WS_PORT=8080
CODETOTAL_WS_HOST=127.0.0.1
DEBUG_MODULES=actions,megalinter,stores,transport
# FRONTEND
UPLOAD_FILE_LIMIT_BYTES=10000000 # 10MB
```

## Building For Production

- Config files must be set before the build (see `Config` section)
- Run `npm run build` at the root folder
- This will create a `dist` folder with the backend code
Expand Down

0 comments on commit b92205c

Please sign in to comment.