-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
- Loading branch information
There are no files selected for viewing
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
ss3d.space |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<h3 align="center"><img src="https://raw.githubusercontent.com/RE-SS3D/SS3D-Art/main/Artwork/Banners/BorderedBanners/SS3DBanner3.png" alt="SS3D Banner">Website repository for <a href="https://ss3d.space/">Space Station 3D</a>!</h3> | ||
|
||
<br> | ||
|
||
<h3>Located at: | ||
<a href="https://ss3d.space/"><img src="https://img.shields.io/website?down_color=red&down_message=offline&label=ss3d.space&up_color=green&style=plastic&up_message=online&url=https%3A%2F%2Fss3d.space" alt="website status" style="vertical-align:middle"></a> | ||
<a href="https://github.com/RE-SS3D/SS3D-Website"><img src="https://img.shields.io/github/repo-size/RE-SS3D/SS3D-Website?color=gold&style=plastic" alt="repo size" align="right"></a> | ||
<a href="https://github.com/RE-SS3D/SS3D-Website/blob/release/.github/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/RE-SS3D/SS3D-Website/build.yml?style=plastic" alt="build status" align="right"></a> | ||
<h3> | ||
|
||
## Requirements | ||
|
||
- [jekyll](https://jekyllrb.com/docs/installation/) | ||
- [rmagick](https://github.com/rmagick/rmagick) | ||
|
||
## Local Setup | ||
|
||
### On Linux | ||
|
||
Linux is the simplest as it's what these technologies are designed for. Especially ubuntu: | ||
|
||
sudo apt install libmagickwand-dev | ||
gem install jekyll bundler rmagick | ||
git clone https://github.com/RE-SS3D/SS3D-Website | ||
cd Website | ||
bundle | ||
|
||
### On Windows | ||
|
||
On windows you need to use [WSL - Ubuntu](https://www.microsoft.com/en-nz/p/ubuntu-1804-lts/9n9tngvndl3q?rtc=1&activetab=pivot:overviewtab) Search for the 18.04 version otherwise you will get errors. The instructions below are based on the [jekyll WSL instructions](https://jekyllrb.com/docs/installation/windows/) and [rmagick install instructions](https://github.com/rmagick/rmagick). | ||
|
||
Once ubuntu is downloaded, open up powershell or command prompt, or directly open ubuntu (and skip the first line). | ||
|
||
bash | ||
sudo apt update -y && sudo apt upgrade -y | ||
sudo apt-add-repository ppa:brightbox/ruby-ng -y | ||
sudo apt install ruby2.5 ruby2.5-dev build-essential dh-autoreconf libmagickwand-dev -y | ||
sudo gem update (ignore errors and continue) | ||
sudo gem install jekyll:3.1.6 rmagick:5.1.0 bundler:2.3.6 | ||
jekyll -v (should report 3.1.6) | ||
cd "website location" (or open the console form the website location) | ||
sudo bundle install | ||
|
||
Enter each line one by one, the whole process might take a while. | ||
You can confirm jekyll is installed by entering: | ||
|
||
jekyll -v | ||
|
||
Finally, whenever you want to run the website, open bash and navigate to the folder in which this repo is cloned, | ||
then follow the next section. | ||
|
||
*Hint: you can easily open ubuntu at a desired folder by opening the folder, shift-right clicking on an empty section in the folder with nothing selected, and selecting 'Open PowerShell window here', then typing `bash` into the prompt.* | ||
|
||
## Running local website | ||
|
||
bundle exec jekyll serve | ||
|
||
Add: | ||
|
||
- `--watch` for automatically rebuilding site for any changes. | ||
- `--host 0.0.0.0` to make server listen on all IPs, to allow for mobile testing. | ||
- `--future` if you are testing a blog post with a date/time in the future. | ||
|
||
Website should be accessible at <http://localhost:4000/> | ||
|
||
## Creating the Devblog | ||
|
||
A template for the blog posts exists at [./_drafts/devblog-format.md](./_drafts/devblog-format.md). | ||
|
||
A checklist regarding the process of the devblog can be found on our [management board](https://trello.com/c/jLB9dKJH). | ||
|
||
## LICENSE | ||
|
||
All **CODE** falls under the **[MIT](https://github.com/RE-SS3D/.github/blob/main/LICENSE-CODE.md)** license. | ||
|
||
All **ASSETS** fall under the **[CC BY-NC-SA 4.0](https://github.com/RE-SS3D/.github/blob/main/LICENSE-ASSETS.md)** license. |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.