2019-05-06 16:24:44 +09:00
|
|
|
# notify.moe
|
2017-06-11 11:51:31 +02:00
|
|
|
|
2024-03-12 11:34:38 +01:00
|
|
|
Anime tracker, database and community.
|
2018-04-26 11:20:20 +02:00
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
## Prerequisites
|
2019-04-19 19:24:53 +09:00
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
* Install [Linux](https://en.wikipedia.org/wiki/Linux), [MacOS](https://en.wikipedia.org/wiki/MacOS) or [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
|
2019-08-27 17:45:18 +09:00
|
|
|
* Install [Go](https://golang.org/)
|
|
|
|
|
* Install [TypeScript](https://www.typescriptlang.org/)
|
2018-04-10 12:54:48 +02:00
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
## Installation
|
2019-04-14 16:28:30 +09:00
|
|
|
|
2019-04-24 07:57:48 +09:00
|
|
|
```shell
|
2024-03-12 11:34:38 +01:00
|
|
|
git clone https://git.akyoto.dev/web/notify.moe.git
|
2019-08-27 17:45:18 +09:00
|
|
|
cd notify.moe
|
2019-09-02 08:50:13 +09:00
|
|
|
go mod download
|
2019-08-27 17:45:18 +09:00
|
|
|
make tools
|
|
|
|
|
make assets
|
2019-09-09 08:46:43 +09:00
|
|
|
make server
|
|
|
|
|
make db
|
2019-08-27 17:45:18 +09:00
|
|
|
./notify.moe
|
2018-04-10 12:54:48 +02:00
|
|
|
```
|
|
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
## Networking
|
2019-04-18 19:34:46 +09:00
|
|
|
|
2019-04-25 09:26:03 +09:00
|
|
|
* Add `beta.notify.moe 127.0.0.1` to your `hosts` file
|
2019-08-27 17:45:18 +09:00
|
|
|
* Run `make ports`
|
2019-04-18 19:34:46 +09:00
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
## In your browser
|
2019-04-18 19:29:33 +09:00
|
|
|
|
2019-04-25 09:26:03 +09:00
|
|
|
* Open the settings, search for certificates
|
|
|
|
|
* Import the file `security/default/root.crt` as a trusted Root authority
|
|
|
|
|
* Open `https://beta.notify.moe`
|
2018-04-26 11:20:20 +02:00
|
|
|
|
2019-09-10 09:31:55 +09:00
|
|
|
## What now?
|
2019-04-29 07:40:02 +09:00
|
|
|
|
2019-09-02 08:50:13 +09:00
|
|
|
* Try the [example task for newcomers](docs/new-contributor-task.md).
|
|
|
|
|
* Make some changes and upload them to a new branch on your fork.
|
|
|
|
|
* Create a pull request on this repository.
|
2019-04-29 07:40:02 +09:00
|
|
|
|
2019-09-02 08:50:13 +09:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Please read [CONTRIBUTING.md](docs/contributing.md) for details on how to contribute to this project.
|
|
|
|
|
|
2019-05-06 21:17:07 +09:00
|
|
|
## Statistics
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-05-06 19:40:36 +09:00
|
|
|
## Style
|
2019-05-06 16:24:44 +09:00
|
|
|
|
|
|
|
|
Please take a look at the [style guidelines](https://github.com/akyoto/quality/blob/master/STYLE.md) if you'd like to make a pull request.
|
|
|
|
|
|
2019-05-06 19:40:36 +09:00
|
|
|
[godoc-image]: https://godoc.org/github.com/animenotifier/notify.moe?status.svg
|
|
|
|
|
[godoc-url]: https://godoc.org/github.com/animenotifier/notify.moe
|
|
|
|
|
[report-image]: https://goreportcard.com/badge/github.com/animenotifier/notify.moe
|
|
|
|
|
[report-url]: https://goreportcard.com/report/github.com/animenotifier/notify.moe
|
|
|
|
|
[tests-image]: https://cloud.drone.io/api/badges/animenotifier/notify.moe/status.svg
|
|
|
|
|
[tests-url]: https://cloud.drone.io/animenotifier/notify.moe
|
|
|
|
|
[coverage-image]: https://codecov.io/gh/animenotifier/notify.moe/graph/badge.svg
|
|
|
|
|
[coverage-url]: https://codecov.io/gh/animenotifier/notify.moe
|
2019-05-24 14:06:40 +09:00
|
|
|
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
|
2024-03-12 11:34:38 +01:00
|
|
|
[sponsor-url]: https://ko-fi.com/akyoto
|
