60 lines
1.7 KiB
Markdown
Raw Normal View History

2019-05-06 07:24:44 +00:00
# {name}
{go:header}
2019-09-10 00:31:55 +00:00
## Prerequisites
2019-05-06 07:24:44 +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/)
2019-05-06 07:24:44 +00:00
2019-09-10 00:31:55 +00:00
## Installation
2019-05-06 07:24:44 +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
2019-05-06 07:24:44 +00:00
```
2019-09-10 00:31:55 +00:00
## Networking
2019-05-06 07:24:44 +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-05-06 07:24:44 +00:00
2019-09-10 00:31:55 +00:00
## In your browser
2019-05-06 07:24:44 +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`
2019-09-10 00:31:55 +00:00
## What now?
2019-05-06 07:24:44 +00:00
* Try the [example task for newcomers](docs/new-contributor-task.md).
2019-08-27 08:45:18 +00:00
* Make some changes and upload them to a new branch on your fork.
* Create a pull request on this repository.
2019-05-06 07:24:44 +00:00
## Find us
* [Discord](https://discord.gg/0kimAmMCeXGXuzNF)
* [Facebook](https://www.facebook.com/animenotifier)
* [Twitter](https://twitter.com/animenotifier)
* [GitHub](https://github.com/animenotifier/notify.moe)
## Contributing
2019-08-29 10:50:48 +00:00
Please read [CONTRIBUTING.md](docs/contributing.md) for details on how to contribute to this project.
2019-05-06 07:24:44 +00:00
2019-05-06 12:17:07 +00:00
## Statistics
![Uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m777678498-177cb6b2990056768877bc2a.svg)
![Mozilla Observatory](https://img.shields.io/mozilla-observatory/grade/notify.moe.svg?publish)
![Chrome Extension](https://img.shields.io/chrome-web-store/users/hajchfikckiofgilinkpifobdbiajfch.svg?label=chrome%20users)
![Firefox Extension](https://img.shields.io/amo/users/anime-notifier.svg?label=firefox%20users)
2019-05-06 07:24:44 +00:00
{go:footer}