notify.moe

README

Anime Notifier

How to

Prerequisites

• Install Docker
• Install Docker Compose

Installation

Download the source code:

git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe

Download the developer tools:

docker pull animenotifier/notify.moe

Run the developer tools:

docker-compose run notify.moe

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.

• Fork the notify.moe repository on GitHub
• Enter the notify.moe directory: cd notify.moe
• Compile TypeScript files using: tsc
• Compile template/style files using: pack (optional)
• Start the web server using: run

The run binary is a file watcher that will restart the web server when it detects code changes.

Networking

• Add beta.notify.moe 127.0.0.1 to your hosts file
• Forward TCP port 4001 to 443 (Linux / MacOS users can run make ports)

In your browser

• Open the settings, search for certificates
• Import the file security/default/root.crt as a trusted Root authority
• Open https://beta.notify.moe

Find us

• Discord
• Facebook
• Twitter
• Google+
• GitHub

Contributing

Please read CONTRIBUTING.md for details on how to contribute to this project.

License

This project is licensed under the MIT License.

Author

Eduard Urbach