111 lines
3.5 KiB
Markdown
Raw Normal View History

2019-04-19 10:24:53 +00:00
# Anime Notifier
2017-06-11 09:51:31 +00:00
[![Godoc reference][godoc-image]][godoc-url]
2018-05-30 09:07:28 +00:00
[![Go report card][goreportcard-image]][goreportcard-url]
[![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-25 00:26:03 +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-19 10:24:53 +00:00
### Installation
2018-04-10 10:54:48 +00:00
2019-04-25 00:26:03 +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-25 00:26:03 +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-25 00:26:03 +00:00
Start the developer tools:
2019-04-14 07:28:30 +00:00
2019-04-23 22:57:48 +00:00
```shell
2019-04-25 00:00:53 +00:00
docker-compose up -d
2018-04-10 10:54:48 +00:00
```
2019-04-25 00:26:03 +00:00
Attach to a terminal:
2019-04-18 10:29:33 +00:00
2019-04-25 00:00:53 +00:00
```shell
docker attach notify.moe
```
2018-04-10 10:54:48 +00:00
2019-04-25 00:00:53 +00:00
### Start the server
2019-04-23 22:57:48 +00:00
2019-04-25 00:26:03 +00:00
* Enter the notify.moe directory: `cd notify.moe`
* Download dependencies: `go mod download`
2019-04-25 00:26:03 +00:00
* Compile TypeScript files using: `tsc`
* Start the web server using: `run`
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-25 00:26:03 +00:00
* Add `beta.notify.moe 127.0.0.1` to your `hosts` file
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-25 00:26:03 +00:00
* Open the settings, search for certificates
* Import the file `security/default/root.crt` as a trusted Root authority
* Open `https://beta.notify.moe`
2019-04-25 00:00:53 +00:00
### Tips
* You can detach from the terminal using `Ctrl P -> Ctrl Q`.
2019-04-25 00:12:10 +00:00
* If you need to shutdown everything, use `docker-compose down`.
2019-04-25 00:00:53 +00:00
* Your home directory is mounted as `/my` inside Docker.
* Fork the notify.moe repository and upload your changes to the fork.
* Clone all the repositories you use into a `projects` directory inside your home files.
2019-04-25 00:26:03 +00:00
* The `run` binary is a file watcher that will restart the web server when it detects code changes.
* File modification events [don't work](https://github.com/docker/for-win/issues/56) on Docker for Windows.
2019-04-25 00:00:53 +00:00
* Use an editor like [Visual Studio Code](http://code.visualstudio.com) to access the source code on the host.
2019-04-25 00:26:03 +00:00
* To automatically compile TypeScript files in VS Code, press `Ctrl Shift B` and select `tsc: watch`.
* Use a Linux system for maximum performance.
2019-04-25 00:00:53 +00:00
2019-04-25 09:52:59 +00:00
### Bookmark
Create a bookmark in your browser and set this code as the URL:
```js
javascript:(() => {
location = location.href.indexOf('://beta.') === -1 ?
location.href.replace('://', '://beta.') : location.href.replace('://beta.', '://');
})();
```
Clicking this bookmark will let you switch between `notify.moe` (live) and `beta.notify.moe` (development).
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)
2019-04-25 00:00:53 +00:00
* [Docker](https://hub.docker.com/r/animenotifier/notify.moe)
2019-04-19 10:24:53 +00:00
* [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
| [![Eduard Urbach on Twitter](https://gravatar.com/avatar/16ed4d41a5f244d1b10de1b791657989?s=70)](https://twitter.com/eduardurbach "Follow @eduardurbach on Twitter") |
2018-06-30 05:16:29 +00:00
|---|
| [Eduard Urbach](https://eduardurbach.com) |
[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
[travis-image]: https://travis-ci.org/animenotifier/notify.moe.svg?branch=go
[travis-url]: https://travis-ci.org/animenotifier/notify.moe