notify.moe/README.md

53 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2019-05-06 07:24:44 +00:00
# notify.moe
2017-06-11 09:51:31 +00:00
2024-03-12 10:34:38 +00:00
Anime tracker, database and community.
2019-09-10 00:31:55 +00:00
## Prerequisites
2019-04-19 10:24:53 +00:00
2019-09-10 00:31:55 +00: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 08:45:18 +00:00
* Install [Go](https://golang.org/)
* Install [TypeScript](https://www.typescriptlang.org/)
2018-04-10 10:54:48 +00:00
2019-09-10 00:31:55 +00:00
## Installation
2019-04-14 07:28:30 +00:00
2019-04-23 22:57:48 +00:00
```shell
2024-03-12 10:34:38 +00:00
git clone https://git.akyoto.dev/web/notify.moe.git
2019-08-27 08:45:18 +00:00
cd notify.moe
2019-09-01 23:50:13 +00:00
go mod download
2019-08-27 08:45:18 +00:00
make tools
make assets
2019-09-08 23:46:43 +00:00
make server
make db
2019-08-27 08:45:18 +00:00
./notify.moe
2018-04-10 10:54:48 +00:00
```
2019-09-10 00:31:55 +00:00
## Networking
2019-04-18 10:34:46 +00:00
2019-04-25 00:26:03 +00:00
* Add `beta.notify.moe 127.0.0.1` to your `hosts` file
2019-08-27 08:45:18 +00:00
* Run `make ports`
2019-04-18 10:34:46 +00:00
2019-09-10 00:31:55 +00:00
## In your browser
2019-04-18 10:29:33 +00:00
2019-04-25 00:26:03 +00:00
* Open the settings, search for certificates
* Import the file `security/default/root.crt` as a trusted Root authority
* Open `https://beta.notify.moe`
2024-03-12 11:40:01 +00:00
## License
2019-04-28 22:40:02 +00:00
2024-03-12 11:40:01 +00:00
Please see the [license documentation](https://akyoto.dev/license).
2019-04-28 22:40:02 +00:00
2024-03-12 11:40:01 +00:00
## Copyright
2019-09-01 23:50:13 +00:00
2024-03-12 11:40:01 +00:00
© 2016 Eduard Urbach
2019-05-06 07:24:44 +00:00
2019-05-06 10:40:36 +00: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 05:06:40 +00:00
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
2024-03-12 10:34:38 +00:00
[sponsor-url]: https://ko-fi.com/akyoto