💃 Anime tracker, database and community. 2,518 Commits
2019-05-05 14:35:08 +09:00
.vscode Updated VS Code settings 2019-04-19 21:01:15 +09:00
audio Added soundtrack download 2018-03-11 02:10:49 +01:00
auth Improved twitter login 2019-03-05 15:44:48 +09:00
benchmarks Fixed components benchmark 2018-11-06 12:53:48 +09:00
bots Changed import path order 2019-04-23 14:52:55 +09:00
docker Updated dockerfile 2019-04-29 00:49:39 +09:00
docs Fixed hierarchy level in code style docs 2018-10-27 06:12:37 +09:00
images Updated Google SVG icon 2019-03-30 18:50:10 +09:00
jobs Cleanup 2019-04-30 23:59:53 +09:00
layout Use the image server 2019-05-05 14:35:08 +09:00
logs Added logs/jobs gitignore file 2018-03-21 05:35:45 +01:00
middleware Changed import path order 2019-04-23 14:52:55 +09:00
mixins Cleanup 2019-04-30 23:59:53 +09:00
pages Use the image server 2019-05-05 14:35:08 +09:00
patches Changed import path order 2019-04-23 14:52:55 +09:00
scripts Calendar now saves the "show added anime only" setting 2019-04-27 20:23:15 +09:00
security Removed useless default private key 2018-06-23 14:42:38 +09:00
styles Don't use forced video ratio on fullscreen 2019-03-04 20:26:25 +09:00
tools Added tools package to track "pack" and "run" 2019-05-01 07:57:40 +09:00
utils Cleanup 2019-04-30 23:59:53 +09:00
videos Added patch to optimize WebM files 2018-11-08 19:12:49 +09:00
.drone.yml Enable code duplication checks 2019-04-30 16:44:44 +09:00
.editorconfig Fixed missing whitespaces 2017-11-09 20:39:49 +01:00
.gitattributes Update .gitattributes 2019-04-08 13:59:09 +09:00
.gitignore Updated dependencies 2019-04-12 16:44:05 +09:00
assets.go Proxy subtitles from S3 2018-12-11 15:37:15 +09:00
config.json Added character comments 2018-11-01 15:06:04 +09:00
CONTRIBUTING.md Updated docs 2018-06-30 20:45:19 +09:00
docker-compose.yml Update docker image 2019-04-28 23:26:51 +09:00
go.mod Use the image server 2019-05-05 14:35:08 +09:00
go.sum Use the image server 2019-05-05 14:35:08 +09:00
graphql.go Changed import path order 2019-04-23 14:52:55 +09:00
LICENSE Added license 2017-07-06 00:50:12 +02:00
main_test.go Improved tests 2019-04-29 01:00:57 +09:00
main.go Docker config is now in its own repository 2019-04-19 19:00:41 +09:00
makefile Removed goimports 2019-04-24 00:20:43 +09:00
organization.json E-mail address change 2018-03-14 12:38:26 +01:00
profiler.go Activate profiling on all versions 2019-03-26 19:31:34 +09:00
README.md More README updates 2019-04-29 07:41:42 +09:00
rewrite.go Simplified search route 2017-11-11 16:16:25 +01:00
security.go Changed import path order 2019-04-23 14:52:55 +09:00
systemd.service Added realtime scheduler 2019-04-21 20:56:17 +09:00
tsconfig.json Removed unused parameters in scripts 2019-04-22 18:06:50 +09:00

Anime Notifier

Godoc reference Go report card Tests Code coverage License

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).

Bookmark

Create a bookmark in your browser and set this code as the URL:

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).

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 on Twitter
Eduard Urbach