web/notify.moe
Code Issues Pull Requests Activity

Improved README

Browse Source
This commit is contained in:
Eduard Urbach 2019-04-19 19:24:53 +09:00
parent a1c3ca029d
commit e720d0df5f
2 changed files with 27 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,35 +1,37 @@
# Installation
# Anime Notifier
[![Godoc reference][godoc-image]][godoc-url]
[![Go report card][goreportcard-image]][goreportcard-url]
[![Build status][travis-image]][travis-url]
## Prerequisites
## How to
### Prerequisites
* Install [Docker](https://www.docker.com/get-started)
* Install [Docker Compose](https://docs.docker.com/compose/install/)
## How to
### Installation
1. Download the source code:
Download the source code:
```bash
git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe
```
2. Download the developer tools:
Download the developer tools:
```bash
docker pull animenotifier/notify.moe
```
3. Run the developer tools:
Run the developer tools:
```bash
docker-compose run notify.moe
```
## Usage
### Usage
Your home directory is mounted as `/my` inside Docker.
@ -43,17 +45,33 @@ Usually you'd want to clone all repositories you use into a `projects` directory
The `run` binary is a file watcher that will restart the web server when it detects code changes.
## Networking
### Networking
* Add `beta.notify.moe 127.0.0.1` to your `hosts` file
* Forward TCP port 4001 to 443 (Linux / MacOS users can run `make ports`)
## In your browser
### 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`
## Find Us
* [Discord](https://discord.gg/0kimAmMCeXGXuzNF)
* [Facebook](https://www.facebook.com/animenotifier)
* [Twitter](https://twitter.com/animenotifier)
* [Google+](https://plus.google.com/+AnimeReleaseNotifierOfficial)
* [GitHub](https://github.com/animenotifier/notify.moe)
## Contributing
Please read [CONTRIBUTING.md](https://github.com/animenotifier/notify.moe/blob/go/CONTRIBUTING.md) for details on how to contribute to this project.
## License
This project is licensed under the [MIT License](https://github.com/animenotifier/notify.moe/blob/go/LICENSE).
## Author
| [![Eduard Urbach on Twitter](https://gravatar.com/avatar/16ed4d41a5f244d1b10de1b791657989?s=70)](https://twitter.com/eduardurbach "Follow @eduardurbach on Twitter") |

60
docker/README.md
View File

@ -1,60 +0,0 @@
# animenotifier/notify.moe
This is a fully pre-configured development environment for Anime Notifier development (notify.moe).
## Getting Started
### Prerequisities
In order to run this container you'll need docker installed.
* [Linux](https://docs.docker.com/linux/started/)
* [Mac](https://docs.docker.com/mac/started/)
* [Windows](https://docs.docker.com/windows/started)
### Usage
#### Download the image
```shell
docker pull animenotifier/notify.moe
```
#### Boot up the dev environment
Download the notify.moe repository to get access to the docker-compose configuration. Run the following inside the repository:
```shell
docker-compose run notify.moe
```
#### Volumes
* `/my` - Your home directory
## Built With
* Arch Linux
* Aero
* Git
* ...any many others.
## Find Us
* [Discord](https://github.com/animenotifier/notify.moe)
* [GitHub](https://github.com/animenotifier/notify.moe)
## Contributing
Please read [CONTRIBUTING.md](https://github.com/animenotifier/notify.moe/blob/go/CONTRIBUTING.md) for details on how to contribute to this project.
## Authors
* **Eduard Urbach** - [eduardurbach.com](https://eduardurbach.com)
See also the list of [contributors](https://github.com/animenotifier/notify.moe/graphs/contributors) who
participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/animenotifier/notify.moe/blob/go/LICENSE) file for details.