2019-05-06 07:24:44 +00:00
|
|
|
# notify.moe
|
2017-06-11 09:51:31 +00:00
|
|
|
|
2019-05-06 07:24:44 +00:00
|
|
|
[![Godoc][godoc-image]][godoc-url]
|
|
|
|
|
[![Report][report-image]][report-url]
|
2019-04-28 15:56:58 +00:00
|
|
|
[![Tests][tests-image]][tests-url]
|
2019-05-06 07:24:44 +00:00
|
|
|
[![Coverage][coverage-image]][coverage-url]
|
2019-05-24 05:06:40 +00:00
|
|
|
[![Sponsor][sponsor-image]][sponsor-url]
|
2018-04-26 09:20:20 +00:00
|
|
|
|
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
|
2019-08-27 08:45:18 +00:00
|
|
|
git clone https://github.com/animenotifier/notify.moe.git
|
|
|
|
|
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`
|
2018-04-26 09:20:20 +00:00
|
|
|
|
2019-09-10 00:31:55 +00:00
|
|
|
## What now?
|
2019-04-28 22:40:02 +00:00
|
|
|
|
2019-09-01 23:50:13 +00: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-28 22:40:02 +00:00
|
|
|
|
2019-04-19 12:10:58 +00:00
|
|
|
## Find us
|
2019-04-19 10:24:53 +00:00
|
|
|
|
|
|
|
|
* [Discord](https://discord.gg/0kimAmMCeXGXuzNF)
|
|
|
|
|
* [Facebook](https://www.facebook.com/animenotifier)
|
|
|
|
|
* [Twitter](https://twitter.com/animenotifier)
|
|
|
|
|
* [GitHub](https://github.com/animenotifier/notify.moe)
|
|
|
|
|
|
2019-09-01 23:50:13 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Please read [CONTRIBUTING.md](docs/contributing.md) for details on how to contribute to this project.
|
|
|
|
|
|
2019-05-06 12:17:07 +00:00
|
|
|
## Statistics
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-05-06 10:40:36 +00:00
|
|
|
## Style
|
2019-05-06 07:24:44 +00: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 10:40:36 +00:00
|
|
|
## Sponsors
|
2019-05-06 07:24:44 +00:00
|
|
|
|
2019-08-27 08:45:18 +00:00
|
|
|
| [](https://github.com/cedricfung) | [](https://github.com/soulcramer) | [](https://eduardurbach.com) |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| [Cedric Fung](https://github.com/cedricfung) | [Scott Rayapoullé](https://github.com/soulcramer) | [Eduard Urbach](https://eduardurbach.com) |
|
2018-06-30 05:16:29 +00:00
|
|
|
|
2019-05-24 05:06:40 +00:00
|
|
|
Want to see [your own name here?](https://github.com/users/akyoto/sponsorship)
|
2018-06-30 05:16:29 +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
|
|
|
|
|
[sponsor-url]: https://github.com/users/akyoto/sponsorship
|
