sanspace / react-tutorial

React Tutorial is the best place to learn how to use React and Meteor together

Meteor React Tutorial

If you are looking for the tutorial, please go to https://react-tutorial.meteor.com and check it there.

This repository is the place to check the code (src folder) and to make contributions.

Read in the tutorial home page where you should ask questions (spoiler: Forums or Slack).

This is a hexo static site used to generate the Meteor React Tutorial Docs.

Contributing

We'd love your contributions! Please send us Pull Requests or open issues on github. Also, read the contribution guidelines.

If you are making a larger contribution, you may need to run the site locally:

Running locally

• Install nvm to manage your Node.js (yes, this is an hexo project and not Meteor, in Meteor you don't need to worry about Node.js versions at all)

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

• Install Node.js 8.11.2:

  nvm install 8.11.2

• Install the project

  npm install

• Run it

  npm start

Styles and Lint

Make sure your changes are not breaking styles and lint rules, in the root project, run:

• npm install
• npm run quave-check

quave-check should not return any error or warning. If it does you need to fix them before sending a PR.

If you get an error because some npm modules are not resolved (import/no-unresolved) you need to run npm install inside the Meteor project that is throwing this error so you generate the node_modules folder for it.

We have a git hook to prevent commits that are not passing these rules but it's good to double-check as maybe your hooks set up can be messed up.

Making a Pull Request

• Create a fork and make your changes on it.

• Test your changes and make sure you sync your code changes (src folder) with your text changes (tutorial folder).

• Build your changes:

npm run build

• Create your Pull Request against master branch.

• Sign the CLA.

• Wait for feedback or approval.