web/notify.moe
Code Issues Pull Requests Activity

Needs more emoji

Browse Source
This commit is contained in:
Eduard Urbach 2019-04-24 07:57:48 +09:00
parent dae1e9ca34
commit 1af35672c9
1 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -8,26 +8,26 @@
### Prerequisites ### Prerequisites
* Install [Docker](https://www.docker.com/get-started) * Install [Docker](https://www.docker.com/get-started) :whale:
* Install [Docker Compose](https://docs.docker.com/compose/install/) * Install [Docker Compose](https://docs.docker.com/compose/install/) :whale:
### Installation ### Installation
Download the source code: Download the source code:
```bash ```shell
git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe
``` ```
Download the developer tools: Download the developer tools:
```bash ```shell
docker pull animenotifier/notify.moe docker pull animenotifier/notify.moe
``` ```
Run the developer tools: Run the developer tools:
```bash ```shell
docker-compose run notify.moe docker-compose run notify.moe
``` ```
@ -35,26 +35,34 @@ docker-compose run notify.moe
Your home directory is mounted as `/my` inside Docker. 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. Usually you'd want to clone all repositories you use into a `projects` directory inside your home files. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.
* Fork the notify.moe repository on GitHub On your host:
* Enter the notify.moe directory: `cd notify.moe`
* Compile TypeScript files using: `tsc` * Fork the notify.moe repository on GitHub :new:
* Compile template/style files using: `pack` (optional) * Download the fork to your home directory :arrow_down:
* Start the web server using: `run` * Enter the notify.moe directory: `cd notify.moe` :open_file_folder:
* Start the development tools `docker-compose run notify.moe` :whale:
Inside the docker container:
* Enter the notify.moe directory again `cd notify.moe` :open_file_folder:
* Compile TypeScript files using: `tsc` :shaved_ice:
* Start the web server using: `run` :pray:
The `run` binary is a file watcher 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 :page_facing_up:
* Forward TCP port 4001 to 443 (Linux / MacOS users can run `make ports`) * If you're a Linux or Mac user, run `make ports` to forward ports :penguin:
* Otherwise, forward TCP port 4001 to 443 manually :thought_balloon:
### In your browser ### In your browser
* Open the settings, search for certificates * Open the settings, search for certificates :key:
* Import the file `security/default/root.crt` as a trusted Root authority * Import the file `security/default/root.crt` as a trusted Root authority :closed_lock_with_key:
* Open `https://beta.notify.moe` * Open `https://beta.notify.moe` :house_with_garden:
## Find us ## Find us