docs: remove extraneous content from curriculum docs
This commit is contained in:
@@ -1,94 +0,0 @@
|
||||

|
||||
|
||||
# freeCodeCamp Curriculum
|
||||
|
||||
[](https://travis-ci.org/freeCodeCamp/curriculum) [](https://www.npmjs.com/package/@freecodecamp/curriculum)
|
||||
[](http://makeapullrequest.com)
|
||||
[](http://www.firsttimersonly.com/)
|
||||
|
||||
> This package contains the "challenge" files used in the freeCodeCamp Curriculum.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm i @freecodecamp/curriculum
|
||||
# or
|
||||
yarn add @freecodecamp/curriculum
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import { getChallenges } from '@freecodecamp/curriculum';
|
||||
|
||||
// fetch an array of blocks
|
||||
// i.e. basic CSS, functional programming, etc.
|
||||
getChallenges()
|
||||
```
|
||||
|
||||
### `block` Structure
|
||||
|
||||
```js
|
||||
{
|
||||
"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
|
||||
|
||||
```js
|
||||
{
|
||||
"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()"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
1. 🍴 Fork this repo
|
||||
2. 👀️ Follow the contributing guidelines outlined in [Contributing Guidelines](docs/CONTRIBUTING.md).
|
||||
3. 🔧 Make some awesome changes!
|
||||
4. 👉 [Make a pull request](https://github.com/freeCodeCamp/learn/compare)
|
||||
5. 🎉 Get your pull request approved - success!
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2018 freeCodeCamp.
|
||||
|
||||
The curricular content in this repo is licensed under the [CC-BY-SA-4.0](LICENSE.md)
|
Binary file not shown.
Before Width: | Height: | Size: 36 KiB |
Reference in New Issue
Block a user