Skip to content

Development Environment Setup

Jump to bottom
Juan Snyman edited this page Apr 6, 2020 · 2 revisions

In order to start making contributions to the Cloudnine project, you will need to configure your development environment. To do so, follow these steps:

1. Install Git

Check that Git is installed by running git --version in your terminal. If not, you should install it.

After installing, you should set your username in Git and authenticate to GitHub.

2. Install Ruby

Make sure you have the correct version of Ruby installed on your system: in your terminal, run ruby -v. If this doesn't output ruby 2.6.5, you'll need to install this version of Ruby.

NOTE: A newer version of Ruby (2.7.0) has recently been released but Rails hasn't been fully updated to take all of its changes into account. Running a Rails application with Ruby 2.7 therefore results in many deprecation warnings being output. To avoid this annoyance, this project will use Ruby 2.6.5 for the time being.

To install Ruby 2.6.5, follow the official instructions. If you're using Windows, be sure to install a version that includes the Ruby DevKit.

3. Install SQLite

Check that SQLite is installed by running sqlite3 --version. If you get an error, you'll need to install it.

4. Clone the repo

Change directories (using the cd command) to the place where you'd like to save the source code files. Then, clone the repository using one of the following commands:

git clone https://github.com/stringlytyped/cloudnine.git # HTTPS
git clone git@github.com:stringlytyped/cloudnine.git     # SSH

5. Install dependencies

After the clone operation completes, run:

cd cloudnine
bundle install

If you get an error about "bundle" not being a command, you'll need to run gem install bundler and try again.

6. Copy the master.key file

Rails stores secrets like API keys in the encrypted config/credentials.yml.enc file. The key used to decrypt this file is stored in config/master.key but this file isn't committed into source control (doing so would defeat the point of encrypting the credentials file). So, to enable your local project to communicate with Spotify and other API providers, you will need to ask one of the other team members to send you this master.key file and copy it to the config directory.

7. Run the application

To test that everything works, run rails server and navigate to http://localhost:3000 in your browser.

Clone this wiki locally