2019-04-19 10:24:53 +00:00
# Anime Notifier
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]
2019-04-19 10:24:53 +00:00
## How to
### Prerequisites
2018-04-10 10:54:48 +00:00
2019-04-23 22:57:48 +00:00
* Install [Docker ](https://www.docker.com/get-started ) :whale:
* Install [Docker Compose ](https://docs.docker.com/compose/install/ ) :whale:
2018-04-10 10:54:48 +00:00
2019-04-19 10:24:53 +00:00
### Installation
2018-04-10 10:54:48 +00:00
2019-04-19 10:24:53 +00:00
Download the source code:
2019-04-18 11:19:15 +00:00
2019-04-23 22:57:48 +00:00
```shell
2019-04-18 11:19:15 +00:00
git clone https://github.com/animenotifier/notify.moe.git & & cd notify.moe
```
2019-04-19 10:24:53 +00:00
Download the developer tools:
2019-04-14 07:28:30 +00:00
2019-04-23 22:57:48 +00:00
```shell
2019-04-14 07:28:30 +00:00
docker pull animenotifier/notify.moe
```
2019-04-19 10:24:53 +00:00
Run the developer tools:
2019-04-14 07:28:30 +00:00
2019-04-23 22:57:48 +00:00
```shell
2019-04-14 07:28:30 +00:00
docker-compose run notify.moe
2018-04-10 10:54:48 +00:00
```
2019-04-19 10:24:53 +00:00
### Usage
2019-04-18 10:29:33 +00:00
2019-04-18 11:19:15 +00:00
Your home directory is mounted as `/my` inside Docker.
2019-04-23 22:57:48 +00:00
Usually you'd want to clone all repositories you use into a `projects` directory inside your home files. 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-23 22:57:48 +00:00
On your host:
* Fork the notify.moe repository on GitHub :new:
* Download the fork to your home directory :arrow_down:
* Enter the notify.moe directory: `cd notify.moe` :open_file_folder:
* Start the development tools `docker-compose run notify.moe` :whale:
Inside the docker container:
* Enter the notify.moe directory again `cd notify.moe` :open_file_folder:
* Compile TypeScript files using: `tsc` :shaved_ice:
* Start the web server using: `run` :pray:
2019-04-18 10:29:33 +00:00
2019-04-18 11:19:15 +00:00
The `run` binary is a file watcher that will restart the web server when it detects code changes.
2019-04-18 10:29:33 +00:00
2019-04-19 10:24:53 +00:00
### Networking
2019-04-18 10:34:46 +00:00
2019-04-23 22:57:48 +00:00
* Add `beta.notify.moe 127.0.0.1` to your `hosts` file :page_facing_up:
* If you're a Linux or Mac user, run `make ports` to forward ports :penguin:
* Otherwise, forward TCP port 4001 to 443 manually :thought_balloon:
2019-04-18 10:34:46 +00:00
2019-04-19 10:24:53 +00:00
### In your browser
2019-04-18 10:29:33 +00:00
2019-04-23 22:57:48 +00:00
* Open the settings, search for certificates :key:
* Import the file `security/default/root.crt` as a trusted Root authority :closed_lock_with_key:
* Open `https://beta.notify.moe` :house_with_garden:
2018-04-26 09:20:20 +00:00
2019-04-19 12:10:58 +00:00
## Find us
2019-04-19 10:24:53 +00:00
* [Discord ](https://discord.gg/0kimAmMCeXGXuzNF )
* [Facebook ](https://www.facebook.com/animenotifier )
* [Twitter ](https://twitter.com/animenotifier )
* [Google+ ](https://plus.google.com/+AnimeReleaseNotifierOfficial )
* [GitHub ](https://github.com/animenotifier/notify.moe )
## Contributing
Please read [CONTRIBUTING.md ](https://github.com/animenotifier/notify.moe/blob/go/CONTRIBUTING.md ) for details on how to contribute to this project.
## License
This project is licensed under the [MIT License ](https://github.com/animenotifier/notify.moe/blob/go/LICENSE ).
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
