README.md

Pre-release version of Coding Coach.

Looking for a mentor?

Just go to https://mentors.codingcoach.io/ and find her / him.

Requirements

• Git should be installed Install Git
• Nodejs 11.6.0+ installed Install Nodejs
• Yarn (we recommend using yarn as a package manager) Install Yarn

Want to be a mentor?

1. Fork
2. yarn (make sure you have a compatible node version, nvm or fnm can help here)
3. Create a branch "add-{your-name}-as-mentor"
4. Add your details in src/mentors.json file (check the below schema for requirements).
5. Run yarn test to validate that the details is following the right schema (carelfully read the output to see what needs to be fixed)
6. Push the "add-{your-name}-as-mentor" branch to github
7. PR with the title "Add {Your Name} as mentor".
8. Thanks!

Notes:

1. Please double check your details. It’s important that the data scheme remains the same; just replace the details with your values. If you change the data architecture, it will cause errors.
2. In order to avoid merge conflicts, please fetch the changes on master before pushing.

Mentor schema

{
  "id": "your email",
  "name": "your name",                          // minLength: 2
  "avatar": "https://link-to-your/avatar.jpg",  // url, must start with https://
  "title": "NodeJS developer",                  // minLength: 2, maxLength: 30
  "description": "Hi, I'm NodeJs developer",    // minLength: 5, maxLength: 80 optional
  "country": "Israel",                          // Full name. please avoid synonyms (check if it's not already exist)
  "tags": [                                     // minItems: 1, maxItems: 5
    "nodejs", "webpack", "mongodb"              // please avoid synonyms
  ],
  "channels": [                                 // minItems: 1, maxItems: 3
    {
      "type": "email",                          // see available channels below
      "id": "[email protected]"                    // depends on the type
    }
  ]
}

Channels

type	parameter
email	email address
slack	memberID (How to find it?)
linkedin	userId
facebook	userId
twitter	userId

Want to contribute this project?

That's why we here! 😀

Have an idea? Please use a branch and create a PR. If you not sure how to do this, ask us or find a mentor who can assist.

Haven't time to code it? Please open an issue.

---

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.