-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update README, replace references to gitdeploy with GitHub releases, …
…update wording on everything else
- Loading branch information
Showing
1 changed file
with
15 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,14 @@ | ||
| vertigo | ||
| ======= | ||
| [](https://codeship.com/projects/69843) [](https://heroku.com/deploy) | ||
| [](https://www.gitdeploy.io/deploy?repository=https%3A%2F%2Fgithub.jparrowsec.cn%2F9uuso%2Fvertigo.git) [](https://godoc.org/github.com/9uuso/vertigo) | ||
| [](https://gitter.im/9uuso/vertigo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](https://codeship.com/projects/69843) [](https://heroku.com/deploy) [](https://godoc.org/github.com/9uuso/vertigo) | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Vertigo is a yet another Markdown blog engine in Go, but with JSON API. Vertigo is also quite fast and can be run using single binary on all major operating systems like Windows, Linux and MacOSX when using SQLite as database. | ||
| Vertigo is blogging platform similar to [Ghost](https://ghost.org), [Medium](https://medium.com) and [Tumblr](https://www.tumblr.com). Vertigo is written in Go and has fully featured JSON API and it can be run using single binary on all major operating systems like Windows, Linux and OSX. | ||
|
|
||
| The frontend code is powered by Go's `template/html` package and [is relatively simple to use](https://github.com/9uuso/vertigo/blob/master/templates/post/display.tmpl). The template files are in plain HTML and JavaScript (vanilla) only appears on few pages. Disabling JavaScript does not break Vertigo. JavaScript is in general tried to be avoided to provide a better user experience on different devices. | ||
| The frontend code is powered by Go's `template/html` package, which is similar to Mustache.js. The template files are in plain HTML and JavaScript (vanilla) only appears on few pages. JavaScript is stripped down as much as possible to provide a better user experience on different devices. Vertigo also ships without any CSS frameworks, so it is easy to start customizing the frontend with the tools of your choice. | ||
|
|
||
| Vertigo ships without CSS frameworks, so it's easy to start customizing the frontend with tools of your choice. | ||
|
|
||
| With JSON API it's also easy to add your preferred JavaScript MVC on top of Vertigo. The API is fully featured, so one could write a single page application on top of Vertigo just by using JavaScript. Whether you want to take that path or just edit the HTML template files found in `/templates/` is up to you. | ||
| Thanks to the JSON API, it is easy to add your preferred JavaScript MVC on top of Vertigo. This means that you can create users, submit posts and read data without writing a single line of Go code. For example, one could write a single page application on top of Vertigo just by using JavaScript. Whether you want to take that path or just edit the HTML template files found in `/templates/` is up to you. | ||
|
|
||
| ##Features | ||
|
|
||
|
|
@@ -32,13 +28,11 @@ See [my personal website](http://www.juusohaavisto.com/) | |
|
|
||
| ##Installation | ||
|
|
||
| Note: By default the HTTP server starts on port 3000. This can changed by declaring `PORT` environment variable. | ||
|
|
||
| ###Gitdeploy | ||
| Note: By default the HTTP server starts on port 3000. This can changed by declaring `PORT` environment variable or by passing one with the binary execution command. | ||
|
|
||
| Deploy and try out vertigo using gitdeploy: | ||
| ###Downloading binaries | ||
|
|
||
| [](https://www.gitdeploy.io/deploy?repository=https%3A%2F%2Fgithub.jparrowsec.cn%2F9uuso%2Fvertigo.git) | ||
| See [GitHub releases](https://github.com/9uuso/vertigo/releases). | ||
|
|
||
| ###Heroku | ||
|
|
||
|
|
@@ -49,50 +43,29 @@ For advanced usage, see [Advanced Heroku deployment](https://github.com/9uuso/ve | |
| ###Source | ||
|
|
||
| 1. Install Go (I recommend using [gvm](https://github.com/moovweb/gvm)) | ||
| 2. `go get github.com/tools/godep && go get -u github.com/9uuso/vertigo` | ||
| 2. `go get github.com/tools/godep` | ||
| 3. `git clone https://github.com/9uuso/vertigo` | ||
| 4. `cd vertigo && godep go build` | ||
| 5. `PORT="80" ./vertigo` | ||
|
|
||
| ###Docker | ||
| 1. [Install docker](https://docs.docker.com/installation/) | ||
| 2. `cd vertigo` | ||
| 3. `docker build -t "vertigo" .` | ||
| 4. `docker run -d -p 80:80 vertigo` | ||
| 2. `git clone https://github.com/9uuso/vertigo` | ||
| 3. `cd vertigo` | ||
| 4. `docker build -t "vertigo" .` | ||
| 5. `docker run -d -p 80:80 vertigo` | ||
|
|
||
| ###Environment variables | ||
| * `PORT` - the HTTP server port | ||
| * `SMTP_LOGIN` - address from which you want to send mail from. Example: [email protected] | ||
| * `SMTP_PASSWORD` - Password for the mailbox defined with SMTP_LOGIN | ||
| * `SMTP_PORT` - SMTP port which to use to send email. Defaults to 587. | ||
| * `SMTP_SERVER` - SMTP server hostname or IP address. Example: smtp.example.org | ||
| * `DATABASE_URL` - Database connection URL for PostgreSQL | ||
|
|
||
| ##Using SQLite | ||
|
|
||
| Using SQLite as database is simple and requires no additional parameters. You can run SQLite as so: | ||
|
|
||
| `PORT="80" ./vertigo` | ||
|
|
||
| ##Using Postgres | ||
|
|
||
| With Postgres you have two choices: | ||
|
|
||
| ###Flags | ||
|
|
||
| Pass two flags, `driver` and `source`. The driver should always be `postgres` and the `source` should be [connection URL](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING). For example: | ||
|
|
||
| `PORT="80" ./vertigo -driver=postgres [email protected]` | ||
|
|
||
| ###Environment variable | ||
|
|
||
| Define environment variable `DATABASE_URL` with connection URL. After you have set `DATABASE_URL`, you can just Vertigo as you would with SQLite: | ||
|
|
||
| `PORT="80" ./vertigo` | ||
| * `DATABASE_URL` - database connection URL for PostgreSQL - if empty, SQLite will be used | ||
|
|
||
| ##Contribute | ||
|
|
||
| Contributions are welcome, but before creating a pull request, please run your code trough `go fmt` and [`golint`](https://github.com/golang/lint). If the changes introduce new features, please also add tests for them. Try to also squash your commits into one big one instead many small, to avoid unnecessary CI runs. | ||
| Contributions are welcome, but before creating a pull request, please run your code trough `go fmt` and [`golint`](https://github.com/golang/lint). If the changes introduce new features, please add tests for them. Try to squash your commits into one big one instead many small, to avoid unnecessary CI runs. | ||
|
|
||
| ##Support | ||
|
|
||
|
|
||