Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.76 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.76 KB

An online tool to generate fun tasks to complete in the game 'Old School Runescape'.

Why?

Often, whilst playing Runescape, I'll get bored of the grind of doing a single task. Runescape was most fun for me whilst playing with a group of friends, running into random activities . This tool aims to give you goals - some serious, some outlandish - to work towards.

Can I help?

YES!. The app currently works, we are in alpha at the moment. The biggest thing stopping progress is the lack of Data. We need to create, maintain and update our JSON files to give players tasks.

You might not be a coder, or you might be brand new to github, but it's very easy to contribute and help us out!.

Contributing:

Getting involved is easy. You will need a basic understanding of VUE and Github. Runescpape-Goals uses the VUE CLI - This means you will need both NPM & Yarn locally installed

Fork this repo:

Create a fork of this reposity, you can do so at the top of this page.

Download the files:

Clone your fork locally. Be sure you make a branch in git to work from. Do not work in master.

Navigate to the directory you downloaded the source files to and open it in terminal/command prompt, you'll need to run these commands.

Running the files locally:

npm i

Next, run

yarn run serve

Creating a Pull Request:

Once you have finished, commit and push your files to your branch. Come back to this page and open a pull request!.

If any of the the above is confusing I highly recommend reading The beginner's guide to Contributing to a Github project