shibao/cannery
1
2
Fork 1
Code Issues 14 Pull Requests Projects 1 Releases 39 Wiki Activity

- add translation status to readme and contributing guide

Browse Source 
- tweak configs
This commit is contained in:
shibao
2022-02-07 23:15:26 -05:00
parent 24fa837478
commit 94b88f9f9e
6 changed files with 753 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
CONTRIBUTING.md
View File

@ -3,7 +3,14 @@
Thanks for contributing to Cannery! Please read over the style tips to help make
contributing to Cannery (hopefully) as great of an experience as you found it!
## Tips
## Translations needed!
![translation status](https://weblate.bubbletea.dev/widgets/cannery/-/svg-badge.svg)
If you're multilingual, this project can use your translations! Visit
[weblate](https://weblate.bubbletea.dev/engage/cannery/) for more information.
## Style Tips
- In order to cut down on code verbosity and readability, please try to use
inline `do:` blocks for short functions and make your aliases as short as
@ -28,11 +35,14 @@ contributing to Cannery (hopefully) as great of an experience as you found it!
status tuples for other functions like `{:ok, result}` or `{:error,
reason_or_changeset}` instead of just returning `result` or `nil` for easy
pattern matching.
- When adding text, please use `gettext` macros to enable things to be
translated in the future. After adding `gettext` macros, run `mix format` in
order to add your new text strings to the files in `priv/gettext`.
- Before submitting a PR, please make sure all tests are passing using `mix test`.
And as always, thank you!
# Features
# Technical Information
- Created using the [Phoenix Framework](https://www.phoenixframework.org)
- User Registration/Sign in via [`phx_gen_auth`](https://hexdocs.pm/phx_gen_auth/).
@ -54,32 +64,43 @@ And as always, thank you!
# Configuration
For development, I recommend setting environment variables with [direnv](https://direnv.net).
For development, I recommend setting environment variables with
[direnv](https://direnv.net).
By default, Cannery will always bind to all external IPv4 and IPv6 addresses in
`dev` and `prod` mode, respectively. If you would like to use different values,
they will need to be overridden in `config/dev.exs` and `config/runtime.exs` for
`dev` and `prod` modes, respectively.
## `MIX_ENV=dev`
In `dev` mode, Cannery will listen for these environment variables on compile.
In `dev` mode, Cannery will listen for these environment variables at runtime.
- `HOST`: External url to generate links with. Set these especially if you're
behind a reverse proxy. Defaults to `localhost`.
- `PORT`: External port for urls. Defaults to `443`.
- `HOST`: External url to generate links with. Set this especially if you're
behind a reverse proxy. Defaults to `localhost`. External URLs will always be
generated with `https://` and port `443`.
- `PORT`: Internal port to bind to. Defaults to `4000`.
- `DATABASE_URL`: Controls the database url to connect to. Defaults to
`ecto://postgres:postgres@localhost/cannery_dev`.
- `ECTO_IPV6`: Controls if Ecto should use IPv6 to connect to PostgreSQL.
Defaults to `false`.
- `POOL_SIZE`: Controls the pool size to use with PostgreSQL. Defaults to `10`.
- `REGISTRATION`: Controls if user sign-up should be invite only or set to public. Set to `public` to enable public registration. Defaults to `invite`.
- `LOCALE`: Sets a custom locale. Defaults to `en_US`.
## `MIX_ENV=test`
In `test` mode (or in the Docker container), Cannery will listen for the same environment variables as dev mode, but also include the following at runtime:
- `TEST_DATABASE_URL`: REPLACES `DATABASE_URL`. Controls the database url to
connect to. Defaults to `ecto://postgres:postgres@localhost/cannery_test`.
- `MIX_TEST_PARTITION`: Only used if `TEST_DATABASE_URL` is not specified.
Appended to the default database url if you would like to partition your test
databases. Defaults to not set.
## `MIX_ENV=prod`
In `prod` mode (or in the Docker container), Cannery will listen for these environment variables at runtime.
In `prod` mode (or in the Docker container), Cannery will listen for the same environment variables as dev mode, but also include the following at runtime:
- `HOST`: External url to generate links with. Set these especially if you're
behind a reverse proxy. Defaults to `localhost`.
- `PORT`: Internal port to bind to. Defaults to `80` and attempts to bind to
`0.0.0.0`. Must be reverse proxied!
- `DATABASE_URL`: Controls the database url to connect to. Defaults to
`ecto://postgres:postgres@cannery-db/cannery`.
- `ECTO_IPV6`: Controls if Ecto should use ipv6 to connect to PostgreSQL.
Defaults to `false`.
- `POOL_SIZE`: Controls the pool size to use with PostgreSQL. Defaults to `10`.
- `SECRET_KEY_BASE`: Secret key base used to sign cookies. Must be generated
with `mix phx.gen.secret` and set for server to start.
- `REGISTRATION`: Controls if user sign-up should be invite only or set to public. Set to `public` to enable public registration. Defaults to `invite`.
with `docker run -it shibaobun/cannery mix phx.gen.secret` and set for server to start.