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
🐳 Start the developer tools:
docker-compose up -d
🐳 Attach to a terminal:
docker attach notify.moe
Start the server
- Enter the notify.moe directory:
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 yourhosts
file 📄
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
🏡
Tips
- You can detach from the terminal using
Ctrl P -> Ctrl Q
. - 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. - Use an editor like Visual Studio Code to access the source code on the host.
- To automatically compile TypeScript files in VS Code, press
Ctrl Shift B
and selecttsc: watch
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 |