scissorsneedfoodtoo 97360b0f29 docs(contributing): add Contributing Guide
Took the challenge guide from the main repo and reworked it for the Curriculum repo. Moved the
CONTRIBUTING.md file to the root directory. Added an image directory and sample image to more
clearly show how to open a PR and point it to the correct branch, like in the guide in the
main repo.

ISSUES CLOSED: #61
2018-06-29 23:47:58 +05:30
2018-06-24 14:41:31 +01:00
2018-06-08 18:31:07 +05:30
2018-06-11 19:55:04 +05:30
2018-06-24 13:43:00 +00:00
2018-06-24 13:43:00 +00:00

freeCodeCamp Curriculum

Build Status npm (scoped)

This package contains the "seed" files used in the freeCodeCamp Curriculum.

Installation

npm i @freecodecamp/curriculum
# or
yarn add @freecodecamp/curriculum

Usage

import { getChallenges } from '@freecodecamp/curriculum';

// fetch an array of blocks
// i.e. basic CSS, functional programming, etc.
getChallenges()

block Structure

{
  "name": "ES6",
  "order": 2,
  "time": "5 hours",
  "helpRoom": "Help",
  "challenges": [/*<challenge>*/],
  "fileName": "02-javascript-algorithms-and-data-structures/es6.json",
  "superBlock": "javascript-algorithms-and-data-structures",
  "superOrder": 2
}

challenge Structure

{
  "id": "ObjectId()",
  "title": "Declare a Read-Only Variable with the const Keyword",
  "description": [
    "A Description of the challenge and what is required to pass"
  ],
  "tests": [
    {
      "text": "should return \"foo\"",
      "testString": "a stringified function using Chai asserts"
    }
  ],
  "challengeType": 1,
  "translations": {},
  "files": {
    "indexjs": {
      "key": "indexjs",
      "ext": "js",
      "name": "index",
      "contents": [
        "Initial editor seed"
      ],
      "head": [
        "A place for test set up",
        "Can be thought of as mocha's beforeEach()"
      ],
      "tail": [
        "A place for test tear down",
        "Can be thought of as mocha's afterEach()"
        ]
    }
  }
},
Description
Languages
JavaScript 47.2%
TypeScript 46.3%
CSS 6.1%
Shell 0.2%
Dockerfile 0.1%
Other 0.1%