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 inside your home files. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.

On your host:

Fork the notify.moe repository on GitHub 🆕
Download the fork to your home directory ⬇️
Enter the notify.moe directory: cd notify.moe 📂
Start the development tools docker-compose run notify.moe 🐳

Inside the docker container:

Enter the notify.moe directory again cd notify.moe 📂
Compile TypeScript files using: tsc 🍧
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 📄
If you're a Linux or Mac user, run make ports to forward ports 🐧
Otherwise, forward TCP port 443 to 4001 manually 💭

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

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

3.1 KiB Raw Blame History