2018-04-10 16:30:44 +00:00
# Installation
2017-06-11 09:51:31 +00:00
2018-04-26 09:20:20 +00:00
[![Godoc reference][godoc-image]][godoc-url]
2018-05-30 09:07:28 +00:00
[![Go report card][goreportcard-image]][goreportcard-url]
2018-04-26 09:20:20 +00:00
[![Build status][travis-image]][travis-url]
2018-04-10 16:30:44 +00:00
## Prerequisites
2018-04-10 10:54:48 +00:00
2019-04-18 10:29:33 +00:00
* Install [Docker ](https://www.docker.com/get-started )
* Install [Docker Compose ](https://docs.docker.com/compose/install/ )
2018-04-10 10:54:48 +00:00
2019-04-18 10:29:33 +00:00
## Setup
2018-04-10 10:54:48 +00:00
2019-04-18 10:41:54 +00:00
Download the developer image (2.5 GB):
2019-04-14 07:28:30 +00:00
```bash
docker pull animenotifier/notify.moe
```
2019-04-18 10:29:33 +00:00
Run the developer image:
2019-04-14 07:28:30 +00:00
```bash
docker-compose run notify.moe
2018-04-10 10:54:48 +00:00
```
2019-04-18 10:29:33 +00:00
## Usage
Your home directory is mounted as `/my` inside Docker. Usually you'd want to clone all repositories you use into a `projects` directory. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.
2018-04-10 10:54:48 +00:00
2019-04-18 10:41:19 +00:00
* Clone notify.moe repository: `git clone https://github.com/animenotifier/notify.moe.git`
* Enter notify.moe repository: `cd notify.moe`
2019-04-14 10:04:08 +00:00
* Compile TypeScript files using: `tsc`
2019-04-18 10:29:33 +00:00
* Compile template/style files using: `pack` (optional)
* Start the web server using: `run`
The `run` binary is a development server that will restart the web server when it detects code changes.
2019-04-18 10:34:46 +00:00
## Networking
* Add `beta.notify.moe 127.0.0.1` to your hosts file
2019-04-18 10:57:33 +00:00
* Forward TCP port 4001 to 443 (Linux / MacOS users can run `make ports` )
2019-04-18 10:34:46 +00:00
2019-04-18 10:29:33 +00:00
## In your browser
* Import the file `security/default/root.crt` as a trusted Root authority
2018-04-10 11:33:42 +00:00
* Open `https://beta.notify.moe`
2018-04-26 09:20:20 +00:00
2018-06-30 05:16:29 +00:00
## Author
2018-06-30 05:22:06 +00:00
| [](https://twitter.com/eduardurbach "Follow @eduardurbach on Twitter") |
2018-06-30 05:16:29 +00:00
|---|
| [Eduard Urbach ](https://eduardurbach.com ) |
2018-04-26 09:20:20 +00:00
[godoc-image]: https://godoc.org/github.com/animenotifier/notify.moe?status.svg
[godoc-url]: https://godoc.org/github.com/animenotifier/notify.moe
2018-05-30 09:07:28 +00:00
[goreportcard-image]: https://goreportcard.com/badge/github.com/animenotifier/notify.moe
[goreportcard-url]: https://goreportcard.com/report/github.com/animenotifier/notify.moe
2018-04-26 09:20:20 +00:00
[travis-image]: https://travis-ci.org/animenotifier/notify.moe.svg?branch=go
[travis-url]: https://travis-ci.org/animenotifier/notify.moe
