codeninjasllc/codecombat
1
0
Fork 0
mirror of https://github.com/codeninjasllc/codecombat.git synced 2024-11-23 07:38:20 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Page: Dev Setup: Mac
Pages
Access dev database Access power user features Access url params in a view Accessing data through data attribute Add a Mongoose Model Add a collection schema Add a collection Add a form Add a route Add a view Add basic REST endpoints for a collection Add events to a view Add methods for special server endpoints Add space between elements Adventurer Home Aether Ambassador Home Archmage Home Artisan Home Artisan How To Index Autocomplete Tuning Building A Level Call server from view Change player level Chat Room Rules Chat Room Chief Artisan Level Audition Client models Coco Models Coding Guidelines for Artisans Coding Guidelines Component Authoring Guide Component Components And Systems Tabs Connect Backbone to new collection Cookbook Debug a template Dev Setup: General Information Dev Setup: Issues Dev Setup: Linux Dev Setup: Mac Dev Setup: Vagrant Dev Setup: Windows Developer organization Diplomat Home Edit page translations Editing Thang Components Educational Standards Events, subscriptions, shortcuts File system Git Policies Goals HOWTO: Create static teacher page Handle a server error Home Important Artisan Concepts Inspect a view JSON Schema Keyboard Shortcuts Level editor Make yourself admin Mission statement Multiplayer Organize a complicated template Permissions Programming Concepts Project Ideas List Referee Scripting Run dev client on prod db Sample Code Scribe Home Scripts Tab Scripts Settings Tab Show data in a view Simplify Collision Start a New Level Surface System Tasks Tab Technical overview Test client interface Test client Test server endpoint Testing Thang Component System Thang Thangs Tab Third party software and services Tome Translate page strings Treema Versioning Views World i18n Glossary es 419 i18n Glossary nb i18n Glossary ru i18n
0 Dev Setup: Mac
Brian Ball edited this page 2016-02-18 16:31:40 -08:00
Table of Contents

Before You Start

For more information about the tools being installed and what they do, see our third party software and services page.

Most steps take place in the Terminal, which is in Applications > Utilities, or can be found with Spotlight Search. When you run a command and it doesn't end, and you want it to end, use the shortcut Ctrl-C.

These steps are our recommended approach to setting up CodeCombat's development environment. As long as you cover the General Setup Instructions, you can install these tools however you prefer.

Setup Steps

  1. Install Xcode.
  2. Install Xcode Command Line Tools. Open XCode and go through menus Xcode -> Preferences -> Downloads. This will install Git and provide the command line tools for building the development environment.
  3. Install Homebrew. This will help install MongoDB, CodeCombat's database.
  4. Install MongoDB with HomeBrew. brew install mongodb.
  5. Install NVM. This will help in installing Node, the server and NPM, the Node package manager. There are multiple ways to install Node, so if you install the latest Stable version some other way, skip down to setting up GitHub.
  6. Install Node and NPM with NVM. As of writing, we're using Node 5.1.1, so the command is nvm install 5.1.1. Check the node version we're using in package.json.
  7. Use Node 5 (Stable) By Default. nvm alias default 5.1.1. This way Node 5.1.1 is used for every new terminal. Otherwise you'll need to run nvm use 5.1.1 before running any dev environment commands.
  8. Create an account on GitHub. This is where our code repository is hosted.
  9. Configure Git to connect with your GitHub account.
  10. Clone the CodeCombat repository. This will copy our source code and all its history to your computer to be run and modified.
  11. Install and compile CodeCombat source files. Navigate into the folder where you downloaded the CodeCombat repository and run npm install. This will install npm and bower (client library) dependencies, as well as building the public directory, which is what the server... serves.
  12. Add data to MongoDB. See below.
  13. Run the dev environment.
  14. Visit http://localhost:3000/ to see your CodeCombat development environment!

Installing the Database

Download the CodeCombat database (updated every 10 minutes) and import it to your locally running database:

  1. Start MongoDB. From the codecombat folder, run ./bin/coco-mongodb. You should now be able to, from another terminal, run mongo and connect.
  2. Uncompress the dump. Open a new terminal and navigate to the folder where you downloaded the dump.tar.gz file and run tar xzvf [filename]. This will create a dump folder.
  3. Load the uncompressed dump folder into the database. At a normal command prompt run: mongorestore --drop [path to dump].

Following these same steps will also clear out all old data (including any local data you have created) and replace it with just the new data.

If you see an error like no reachable servers when running mongorestore, and mongo is running, try adding --host=127.0.0.1 to the command line options.

In version 3.0.7 of mongoDB is a bug in mongorestore. If you see an error like Failed: restore error: [some file name]: error restoring from dump/[some file name]: insertion error: EOF when running mongorestore, then try adding --batchSize=100 to the command. (try 1000, or 100, or even smaller) see here for a discussion on that

CodeCombat | Home | Blog | Forum | Teachers | Legal | Contribute