Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 3.42 KB

README.md

File metadata and controls

70 lines (48 loc) · 3.42 KB

Code.org

Circle CI Coverage Status

Welcome! You've found the source code for the Code.org website and the Code Studio platform. Code.org is a non-profit dedicated to expanding access to computer science education. You can read more about our efforts at code.org/about.

Quick start

  1. Follow our setup guide to configure your workstation.
  2. rake build to build the application.
  3. bin/dashboard-server to launch the development server.
  4. Open your browser to http://localhost-studio.code.org:3000/.

To see a list of all build commands, run rake from the repository root.

How to help

Wondering where to start? See our contribution guidelines.

What's in this repo?

Here's a quick overview of the major landmarks:

The server for our Code Studio learning platform, a Ruby on Rails application responsible for:

  • Our courses, tutorials, and puzzle configurations
  • User accounts
  • Student progress and projects
  • The "levelbuilder" content creation tools

The server for the Code.org website, a Sinatra application responsible for:

The JavaScript 'engine' for all of our tutorials, puzzle types and online tools. It gets built into a static package that we serve through dashboard. Start here if you are looking for:

JavaScript code specific to our Code Studio learning platform. This also becomes a static package served by dashboard, and is tightly coupled to dashboard code.

Documentation

Everything else

  • aws: Configuration and scripts that manage our deployments.
  • bin: Developer utilties.
  • cookbooks: Configuration management through Chef.
  • shared: Source and assets used by many parts of our application.
  • tools: Git commit hooks.