Skip to content
This repository was archived by the owner on Oct 1, 2020. It is now read-only.

improved docs #43

Open
praj44 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improved docs #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions CONTRIB.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The app is hosted on a Mac Mini in [MacStadium](https://macstadium.com), running

In production, the app listens on a local port and is started by a launch daemon, to expose the app to the internet, Nginx is used as a proxy. All access to the website and API goes through [CloudFlare](https://cloudflare.com) which is used as a DNS provider, cache, CDN and to protect the app from abuse.

## Setting up the environment
## Setting up the better environment

Building and running Sharecuts locally requires the following environment:

Expand All @@ -18,7 +18,7 @@ Building and running Sharecuts locally requires the following environment:
- [B2 command line tool](https://www.backblaze.com/b2/docs/quick_command_line.html)
- PostgreSQL (I recommend using [Postgres.app](http://postgresapp.com))

## Environment variables
## Environmental variables

A `.env` file should be placed in the app's working directory to configure some aspects of the app, here's a brief explanation of the environment variables:

Expand Down Expand Up @@ -50,4 +50,4 @@ A `.env` file should be placed in the app's working directory to configure some

`CF_APP_URL`: The base URL for the app in CloudFlare (optional)

`CF_ENABLED`: `1` = enable CloudFlare `2` = disable CloudFlare
`CF_ENABLED`: `1` = enable CloudFlare `2` = disable CloudFlare