Setup on Windows: a step by step guide - JasperDhaene/codecombat GitHub Wiki

WARNING

The automatic setup for windows is still in development. The first beta released is planned really soon. If you want the latest development news on this setup, ask Glen DC on the CodeCombat chatroom.for more information. Don't try to follow this guide yet!

For now it's best to use the manual installation guide if you want to develop on CodeCombat on the Windows platform.

Index

  1. Download
  2. Introduction
  3. How to use this installation
  4. The first steps
  5. Software guide
  6. Git Initialisation
  7. NPM, Brunch and MongoDB
  8. Final Note

Download

You can download the latest version here (1.0) (beta).

Introduction

The manual installation of the CodeCombat development environment on Windows was tricky, and a lot of users had troubles of this. Therefore we decided to develop a fully automatic setup for Windows, to avoid users getting frustrated, and possibly give up, before they ever started on the real development. That's in a nullshet the short background of why this setup exists in the first place.

Please note that this setup is development and maintained by only one person. This means that there is a high risk of potential bugs. These can and should be reported like any other issue on the official CodeCombat issue list. Because of this solo development process there is probably quite some room for optimisations and improvements possible, to make it work faster, safer and better. Feel free to discuss proposels to improve it, with Glen DC on the CodeCombat chatroom.

Go back to the top.

####How to use this installation First of all you'll have to extract the downloaded archived setup. You can find the download here. Once you've done this, you can just go inside the directory and open the setup.bat file. Don't be scared by this old-school approach, trust me, it's really easy to use!

The only requirements for this setup are a keyboard and a working brain.

The entire installation is command-line based to keep the installation as lightweight and clean as possible. It also allows us to have a minimum amount of depandancies. The installation is question-based. This means that there will be several questions asked. Some are simple Yes or No questions where you respectively answer with Y or N. Other questions are more complex. These type of questions usually ask you to enter a full path. Here follow some important rules when entering a path as the answer of a question:

  • A path should be entered as a full path, that means starting with the Drive Letter and going up from there on. (e.g. c:\directory)
  • Use the backslash ( \ ) character to seperate directory levels.
  • Please avoid whitespace characters in any part of your full path. If you really really insist on having a space character in your path, be sure to surround the entire path with the quote ( " ) character.
  • Make sure to double check your entered before pressing enter, entering a wrong path can lead to a failed setup and even to the modification and/or delations of wrong directories.

The entire setup is designed to be as user friendly and automatic as possible. In fact this guide shouldn't be needed at all. It is only here to fill in, where the setup failed in usability and to make the installation of the environment on Windows even easier, than it already is.

Go back to the top.

####The first steps .

.

.

.

.

.

.

.

Go back to the top.

####Software guide .

.

.

.

.

.

.

.

Go back to the top.

####Git Initialisation .

.

.

.

.

.

.

.

Go back to the top.

####NPM, Brunch and MongoDB This part still has to be implemented in the setup, and for now you'll have to do this step manually. You can start reading the manual setup for windows at this point, to know how to do the final parts of the installation yourself. This should normally go without any problems.

Here is how you can do this last step in short:

  1. Go to your coco directory (with the cd command, or by opening a command prompt in that directory)
  2. Run npm install -g bower brunch nodemon sendwithus
  3. Run bower install
  4. Run gem install sass
  5. Run npm install
  6. Create a directory DIR for your mongodb database. (coco_repository/../cocodb is a good candidate for this)
  7. Run mongod --setParameter textSearchEnabled=true --dbpath <DIR>
  8. Download the up-to-date database dump from here somewhere else, and extract it.
  9. Open a new command line prompt.
  10. Go to the parent directory of the unarchived dump directory.
  11. Copy the start script fromt coco/scripts/windows/SCOCODE.bat to coco/SCOCODE.bat (the root directory of your coco git repository).

Now you can simply start the development environment by:

  1. Doubleclicking the coco/SCOCODE.bat file to start your development environment.
  2. Wait untill the environment has started up.
  3. Visit localhost:3000 in your browser.

That's it, still quite easy, no? In case of any problems with this last step, please contact any CodeCombat developer on the CodeCombat chatroom. Sorry if there are any problems with this manual step, soon this last step will also be completly automatic.

Go back to the top.

####Final Note .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

Go back to the top.

⚠️ **GitHub.com Fallback** ⚠️