Asartea / react-examples

This repository hosts CodeSandbox React examples that are used in The Odin Project's React course.

React Examples

This repository houses react examples which are uploaded to The Odin Project's CodeSandbox account. Ultimately, these examples appear as CodeSandbox embeds in The Odin Project's React Curriculum .

How To Add A React Example

1. Read through the contributing guide.
2. Make sure you have node, npm and npx installed. You may use the Installing Node.js lesson to install these tools.
3. Fork & clone this repository. Install dependencies by running npm install.
4. Create a new example folder by copying the boilerplate folder. And cd into it and install dependencies.

     cp -R ./boilerplate ./<example-name>
     cd ./<example-name>
     npm install

5. Code out your example.
6. Start the dev server npm run start to make sure the example runs as expected.
7. Run npm run lint for ESLint and Prettier to format the code.
8. Create the pull request. (remember to mention which lesson will require the example)

Naming examples

Make sure that examples are clearly named, meaning they should convey what the example is about on a glance. Examples:

// bad
example-1 
state-example 
arrays

// good
hello-world
passing-props 
rendering-arrays-in-jsx

Maintainer Instructions

1. Login to the organisation's CodeSandbox account.
2. Head over to CodeSandbox's GitHub import wizard.
3. Insert example link to the "URL to GitHub" field.
   • This link will be a subdirectory of this repository. For example, to generate a sandbox for the boilerplate example, use https://github.com/TheOdinProject/react-examples/tree/main/boilerplate.
4. Click the "Open Sandbox" button to generate the sandbox.
5. After the sandbox is live, click "Share", then "Copy Embed Code". This code will be placed in our markdown files where needed.

Note: Embed options need to be explored.