web/notify.moe
Code Issues Pull Requests Activity

Improved documentation

Browse Source
This commit is contained in:
Eduard Urbach 2019-04-18 20:19:15 +09:00
parent c670968330
commit 45643bdd92
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -9,15 +9,21 @@
* Install [Docker](https://www.docker.com/get-started) * Install [Docker](https://www.docker.com/get-started)
* Install [Docker Compose](https://docs.docker.com/compose/install/) * Install [Docker Compose](https://docs.docker.com/compose/install/)
## Setup ## How to
Download the developer image (2.5 GB): 1. Download the source code:
```bash
git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe
```
2. Download the developer tools:
```bash ```bash
docker pull animenotifier/notify.moe docker pull animenotifier/notify.moe
``` ```
Run the developer image: 3. Run the developer tools:
```bash ```bash
docker-compose run notify.moe docker-compose run notify.moe
@ -25,23 +31,26 @@ docker-compose run notify.moe
## Usage ## Usage
Your home directory is mounted as `/my` inside Docker. Usually you'd want to clone all repositories you use into a `projects` directory. This directory can be accessed by both your favourite editor on the host machine and also inside Docker. Your home directory is mounted as `/my` inside Docker.
* Clone notify.moe repository: `git clone https://github.com/animenotifier/notify.moe.git` Usually you'd want to clone all repositories you use into a `projects` directory. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.
* Enter notify.moe repository: `cd notify.moe`
* Fork the notify.moe repository on GitHub
* Enter the notify.moe directory: `cd notify.moe`
* Compile TypeScript files using: `tsc` * Compile TypeScript files using: `tsc`
* Compile template/style files using: `pack` (optional) * Compile template/style files using: `pack` (optional)
* Start the web server using: `run` * Start the web server using: `run`
The `run` binary is a development server that will restart the web server when it detects code changes. 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 * 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`) * 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 * Import the file `security/default/root.crt` as a trusted Root authority
* Open `https://beta.notify.moe` * Open `https://beta.notify.moe`