1akshat/pesto-exercise-starter

Instructions

Please read through the instructions carefully.

Requirements

• Please ensure that you have these or later version of node and npm.
  • node >= 12.11.0
  • npm >= 6.11.3
• If you are using Unix-based system
  • use latest version of bash or zsh terminals.
• If you are windows
  • use Git bash.
  • The VSCode internal terminal may not work properly. So use Git Bash where ever possible.
• It is recommended that you use nvm to manage node versions.
• We recommend that you use VSCode with these extensions installed/enabled.
  • ESLint

Steps

1. Fork this repo
2. Clone your version of the repo on your local system
3. cd into the folder where the repo was cloned and run npm install.
4. Then, cd into js-exercises and run npm install for this sub-folder.
5. For each new day, follow the following steps --
   1. Create a new branch.
      • For example, if the topic is Expressing Programs, the branch can be solutions-expressing-programs
   2. Use the commands mentioned below download the questions
   3. Read the README file for instructions.
   4. Solve the question
   5. Commit the files
   6. Push to your repo
   7. Create a pull request on your repo from the above branch to master.
      • DO NOT MERGE THE PR

Adding .env file

If you are getting the warning

WARNING: Consider adding GITHUB_API_KEY to an .env file in the root directory.

then you can add an .env file in the root directory with your GITHUB api key. You can refer to this link to generate your own token.

Here's an example of an .env file:

GITHUB_API_KEY=here_goes_your_api_key

You do NOT need to check any checkbox in "Select Scopes" section. The token is just used to extend the rate limit for downloading files from Github.

Docs

Fetching a question (npm run fetch)

This command lets you fetch a question. Here is an example usage. If you want to fetch a question, you can use npm run fetch and type your question. Here's an example fetching questions cache-function and flip-args

$ npm run fetch

> node .bin/fetchExercise.js

Questions? cache-function flip-args
Fetching files of cache-function
Downloaded file README.md at js-exercises/cache-function
Downloaded file cacheFunction.js at js-exercises/cache-function
Downloaded file cacheFunction.test.js at js-exercises/cache-function
Completed. Fetched README.md,cacheFunction.js,cacheFunction.test.js of cache-function

Fetching files of flip-args
Downloaded file README.md at js-exercises/flip-args
Downloaded file flipArgs.js at js-exercises/flip-args
Downloaded file flipArgs.test.js at js-exercises/flip-args
Completed. Fetched README.md,flipArgs.js,flipArgs.test.js of flip-args

Updating the repo

Before you fetch you questions, the auto-updater will try to update the repository. However, if you want to update manually by running the command npm run update-repo

Restrictions

• Don't modify any code in the .bin and .vscode folders.
• Also, don't modify .babelrc, .eslintrc, jest.config.json.
  • If you need to disable any eslint rule, use inline comments. Refer to this link for more info.
• Don't download any extra dependency for solving any question. You can only use internal node modules.
• A solution will not be considered complete until an implementation and a test file are both provided.
  • For example — if the question is to code add function, then add.js should contain the implementation and add.test.js should contain the test cases.
  • For some questions, test cases are provided. For questions where test cases are missing, you need to add them.
  • Write tests for all the questions using Jest
• For daily exercises the pull request should be created before 8 PM (IST) the next day.
• For long exercises the pull request should be created before 8 PM (IST) on Monday.
• Your homework will not be counted as complete if the pull request is not created within the above time frame.