4.4 KiB

notify.moe

Godoc Report Tests Coverage Patreon

How to

Prerequisites

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
  • Download dependencies: go mod download
  • Compile TypeScript files using: tsc
  • Start the web server using: run

Networking

  • Add beta.notify.moe 127.0.0.1 to your hosts 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.
  • If you need to shutdown everything, use docker-compose down.
  • 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.
  • The run binary is a file watcher that will restart the web server when it detects code changes.
  • File modification events don't work on Docker for Windows.
  • 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 select tsc: watch.
  • Use a Linux system for maximum performance.

What now?

  • Try the example task for newcomers.
  • Install Pug/Jade and Stylus extensions for your editor.
  • If you're not using VS Code, map Pug/Jade to .pixy and Stylus to .scarlet files (they're similar).
  • Make some changes and upload them to your fork.
  • Create a pull request on this repository (with the diffs of your fork).

Find us

Contributing

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

Statistics

Uptime (30 days) Mozilla Observatory Chrome Extension Firefox Extension

Style

Please take a look at the style guidelines if you'd like to make a pull request.

Sponsors

Scott Rayapoullé Eduard Urbach
Scott Rayapoullé Eduard Urbach

Want to see your own name here?