About   Setup   Testing   Contributing

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.

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

• Node
• Gatsby
• Yarn

The generator uses node and backend framework and yarn as a pack manager.

• Setting up workspace

  • node

    • Download and setup NodeJs from https://nodejs.org/en/download/

  • yarn

    • Download and setup yarn package manager from https://yarnpkg.com/en/docs/install

  • gatsby-cli

    • You can install gatsby-cli using npm via npm install -g gatsby-cli or using yarn via yarn global add gatsby-cli

• Fork the repository
• Clone the repository git clone forked-repository-link
• Navigate inside the repository cd ModuleSite
• Install the dependencies ( yarn is recommended ) yarn

You can test the website locally using gatsby develop or you can deploy the site to GitHub Pages or Render using the deploy scripts present in the scripts directory via NodeJs.

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.
  • Add the original repository as upstream in you local git remote git remote add upstream https://github.com/MovingBlocks/ModuleSite.io
  • 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.

A list of contributors can be found here.