diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52eaf6bd..b0d747d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,4 +4,4 @@ Please get in contact with the team on the [Anime Notifier Discord](https://disc We're willing to help with installations and how to get started with contributions. There are no stupid questions so feel free to ask anything if you encounter any troubles. -If you'd like to install this project locally, take a look at the [Installation](INSTALLATION.md) guide. \ No newline at end of file +If you'd like to install this project locally, take a look at the [Installation](README.md#installation) guide. \ No newline at end of file diff --git a/INSTALLATION.md b/INSTALLATION.md deleted file mode 100644 index 5b18cc82..00000000 --- a/INSTALLATION.md +++ /dev/null @@ -1,24 +0,0 @@ -# Installation - -## Youtube guide - -[![notify.moe Source Code Guide](https://i1.ytimg.com/vi/c6e-F51e_8w/maxresdefault.jpg)](https://www.youtube.com/watch?v=c6e-F51e_8w&=&t=3m42s) - -## Prerequisites - -* Install [Ubuntu](https://www.ubuntu.com/) or [MacOS](https://en.wikipedia.org/wiki/MacOS) -* Install [Go](https://golang.org/dl/) -* Install [TypeScript](https://www.typescriptlang.org/) -* Install [Git LFS](https://git-lfs.github.com/) - -## Start the installation - -```bash -curl -s https://raw.githubusercontent.com/animenotifier/notify.moe/go/install.sh | sudo bash -``` - -## Run the server - -* Start the web server in notify.moe directory using: `run` -* In your browser, import the file `security/default/rootCA.pem` as a trusted Root authority -* Open `https://beta.notify.moe` diff --git a/README.md b/README.md index 21fab8c0..e71d4709 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,36 @@ ## Overview -- [Installation](INSTALLATION.md) -- [Project Management](https://github.com/animenotifier/notify.moe/projects/10) +- [Installation](#installation) - [Code Style](CODE_STYLE.md) - [Contributing](CONTRIBUTING.md) - [Code of Conduct](CODE_OF_CONDUCT.md) +- [Issues](https://github.com/animenotifier/notify.moe/projects/10) + +## Installation + +### Prerequisites + +* Install [Ubuntu](https://www.ubuntu.com/) or [MacOS](https://en.wikipedia.org/wiki/MacOS) +* Install [Go](https://golang.org/dl/) +* Install [TypeScript](https://www.typescriptlang.org/) +* Install [Git LFS](https://git-lfs.github.com/) + +### Start the installation + +```bash +curl -s https://raw.githubusercontent.com/animenotifier/notify.moe/go/install.sh | sudo bash +``` + +### Run the server + +* Start the web server in notify.moe directory using: `run` +* In your browser, import the file `security/default/rootCA.pem` as a trusted Root authority +* Open `https://beta.notify.moe` + +### Youtube guide + +[![notify.moe Source Code Guide](https://i1.ytimg.com/vi/c6e-F51e_8w/maxresdefault.jpg)](https://www.youtube.com/watch?v=c6e-F51e_8w&=&t=3m42s) ## What kind of website is this? diff --git a/pages/users/users.pixy b/pages/users/users.pixy index bdbb947e..41262aa1 100644 --- a/pages/users/users.pixy +++ b/pages/users/users.pixy @@ -36,7 +36,7 @@ component UserLists(groups []*utils.UserList, url string) component StaffRecruitment .footer.mountable p - a(href="https://github.com/animenotifier/notify.moe/blob/go/INSTALLATION.md", target="_blank", rel="noopener") Interested in contributing code? + a(href="https://github.com/animenotifier/notify.moe#installation", target="_blank", rel="noopener") Interested in contributing code? br a(href="https://discord.gg/0kimAmMCeXGXuzNF", target="_blank", rel="noopener") Interested in editing data?