Update README.md
This commit is contained in:
@@ -1,31 +1,11 @@
|
|||||||
# README
|
# README
|
||||||
|
|
||||||
> "Make every detail perfect and limit the number of details to perfect."
|
From AngryJKirk:
|
||||||
> — _Jack Dorsey_
|
|
||||||
|
|
||||||
## About
|
> I took code from https://github.com/josephernest/writing and modified that.
|
||||||
|
>
|
||||||
Dead simple hosting for markdown notes.
|
> Also I changed a lot of things from original repo.
|
||||||
|
>
|
||||||
## Running
|
> Also I dockerized that.
|
||||||
|
>
|
||||||
1. Install `dep` using Homebrew and run it inside project to install the dependencies: `dep ensure`.
|
> Feel free to use!
|
||||||
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`
|
|
||||||
|
|||||||
Reference in New Issue
Block a user