F2P.wiki

F2P.wiki is an open source Old School RuneScape hiscores for Free-to-play players.

Contributing

We are happy to receive any and all help!

• Developers (Ruby, Rails, HTML/CSS/JavaScript)
• Open source experts
• Project owners
• Content managers (FAQs, links, etc.)

Feel free to look at our TODO list for any ideas.

To contribute a code change, please create a separate branch and submit a pull request.

Install and setup

1. Install Git, Ruby, and Bundler

We recommend installing Ruby 2.7.3, but other recent versions may suffice.

Windows

• Git - https://gitforwindows.org/
• Ruby - https://rubyinstaller.org/
• Bundler

gem install bundler

Mac

• Git - https://sourceforge.net/projects/git-osx-installer/files/
• Ruby - http://railsinstaller.org/en
• Bundler

gem install bundler

Linux

Update the packages first using

sudo apt update

• Git

sudo apt-get install git

• Ruby

sudo apt install ruby-full

• Bundler

gem install bundler

2. Verify installation

git --version

ruby --version

bundler --version

3. Fork or clone the repository

git clone https://github.com/vmeow/f2pehp.git

Setting push origin to forked repo

git remote set-url origin --push https://github.com/USERNAME/f2pehp.git

4. Install ruby gems

bundle install

If bundler fails to install/locate pg, try installing libpq-dev first.

sudo apt-get install libpq-dev

5. Run database migrations

bundle exec rake db:migrate

6. Seed with dummy data

bundle exec rake db:seed

7. Verify installation by running server

rails s

The app should now be running at http://localhost:3000 or 127.0.0.1:3000.

Useful Links

Rails Command Line - https://guides.rubyonrails.org/command_line.html

Bundler Commands - https://bundler.io/v2.0/commands.html

License

MIT © F2P.wiki