1 changed files with 9 additions and 29 deletions
@ -1,31 +1,11 @@ |
|||||||
# README |
# README |
||||||
|
|
||||||
> "Make every detail perfect and limit the number of details to perfect." |
From AngryJKirk: |
||||||
> — _Jack Dorsey_ |
|
||||||
|
> I took code from https://github.com/josephernest/writing and modified that. |
||||||
## About |
> |
||||||
|
> Also I changed a lot of things from original repo. |
||||||
Dead simple hosting for markdown notes. |
> |
||||||
|
> Also I dockerized that. |
||||||
## Running |
> |
||||||
|
> Feel free to use! |
||||||
1. Install `dep` using Homebrew and run it inside project to install the dependencies: `dep ensure`. |
|
||||||
2. Create a data base by running `make db`. |
|
||||||
3. Run the app with `make run`. |
|
||||||
|
|
||||||
### ENV variables used: |
|
||||||
|
|
||||||
- For emailing of report abuse: |
|
||||||
- `SMTP_SERVER`: |
|
||||||
- `SMTP_USER` |
|
||||||
- `SMTP_PASSWORD` |
|
||||||
- `NOTEHUB_ADMIN_EMAIL` |
|
||||||
- Recaptcha secret: |
|
||||||
- `RECAPTCHA_SECRET` |
|
||||||
- Test mode: |
|
||||||
- `TEST_MODE` (expected to be non-empty; skips captcha, no writes buffering for stats) |
|
||||||
|
|
||||||
## Testing |
|
||||||
|
|
||||||
1. Install `frisby`: `go get -u github.com/verdverm/frisby`. |
|
||||||
2. Run `make tests` |
|
||||||
|
|||||||
Loading…
Reference in new issue