Module Showcase Website

Keeping track of Terasology's modules since 2019.

---

About   Setup   Contributing

---

About The Project

Terasology’s basic engine can be extended by a huge amount (201 right now!) of modules. Keeping track of them is not the easiest task. This is why this gatsby framework provides an automated generator for a website, listing all of them. This showcase website will increase discoverability by allowing to filter and search for modules by keywords and categories.

---

Getting Started

The module website development environment can be installed on macOS, Windows, and Linux (Debian or Ubuntu recommended). You’ll need at least 1GB of available RAM.

---

Built With

The following generator is built using the following software, you'll need them installed in your workspace to run properly.

• Node
• Gatsby
• Yarn

---

Setting Up Development Workspace

Start by cloning your fork of the ModuleSite repository and connecting the ModuleSite upstream repository:

git clone --config pull.rebase git@github.com:YOURUSERNAME/ModuleSite.git
cd ModuleSite
git remote add -f upstream git@github.com:MovingBlocks/ModuleSite.git

Manual Setup

Steps

• Install the following dependencies on your system

  • Node
  • Yarn
  • Gatsby

• 'cd' into the directory

• Run 'yarn' inside the directory to install all the dependencies

• Once the dependencies are installed you can launch development server via 'yarn run develop'

---

To learn more about the project structure and working of the project please refer to our docs.

Contributing

To add a new feature or fix a bug follow the steps -

• Make sure your local workspace is up-to-date with the main repository.
  • Fetch the latest code git fetch upstream
  • Checkout to your local master branch git checkout master
  • Merge changes from upstream/master to sync git merge upstream/master
• Create a new branch to work on the new feature or bug via the updated master branch git checkout -b "branch_name"
• Work on feature/bug and stage all the files to commit it on that branch git add . > git commit -m "Commit Message"
• Push the branch to your fork git push -u origin branch_name
• Create a pull request.

---

Contributors

A list of contributors can be found here.