Initial commit for Learn React App

Author: tyroprogrammer

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ganesh Bhattarai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,68 +1,89 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Welcome to Learn React App!
 
-## Available Scripts
+The goal of this tutorial is to quickly get you off the ground with `React` concepts. This tutorial has hands on exercises which I consider to be the most important part of this tutorial.
 
-In the project directory, you can run:
+The way this tutorial works is that first you have to checkout this project on your computer, and run the application locally. Then open the application on a browser and you can go through the tutorial as you like.
 
-### `npm start`
+## Checkout
 
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+Checkout the project to your computer using `git`:
 
-The page will reload if you make edits.<br>
-You will also see any lint errors in the console.
+```
+git clone
+```
 
-### `npm test`
+## Environment Setup
 
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+If you don't already have `yarn` installed on your local machine please execute below command to install `yarn`:
 
-### `npm run build`
+```
+npm install -g yarn
+```
 
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
+### Installing Dependencies
 
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
+On the root directory of the project please execute below command to install all the project dependencies:
+```
+yarn install
+```
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+### Starting application
 
-### `npm run eject`
+On the root directory of the project please execute below command to start the tutorial application:
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+```
+yarn start
+```
+After this is complete, the application will be deployed on port `3000`. Open a browser and navigate to `localhost:3000`.
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+-----
 
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+## Following the tutorial
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+Tutorial on this application are fairly straightforward to follow. Each tutorial has one or more exercises. You'll see once you are in the tutorial.
 
-## Learn More
+The exercise panel has split view. The left hand side of the screen has your solution rendered and the right hand side of the screen has the target solution.
+Right above the exercise panel you'll see location of exercise files.
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+Please open the execise file on your favorite editor (VS Code, Atom, Sublime, IntelliJ etc.) and start making changes by following the instructions. Exercise files are heavily commented. Read through the comments and you should be able to write up the solution. If you have any confusion you can refer to the solution file for that exercise. Every time you make changes to the exercise file and save it, the browser will reload automatically reflecting your changes.
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+### Exercise Comment Guide
 
-### Code Splitting
+Most comments in the exercise files starts with one of the below signs. This is to help you understand what you should do to the code immediately following this comments.
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+🏆 - **Trophy** - Describes the overall goal of the exercise. You can find this at the top of the exercise file.
 
-### Analyzing the Bundle Size
+💡 - **Light Bulb** - General information regarding the code immediately following this comment. You might find it throughout the code. No action is required on your part, just read them.
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+✏️   - **Pencil** - You are supposed to edit the code immediately following this comment. It is followed by a description of the change that you need to do.
 
-### Making a Progressive Web App
+🧭  - **Compass** - When the description of change is not enough, compass will give you more direction. You will find it alongside the pencil when more elaborate instruction is deemed necessary.
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+🚨 - **Alarm** - This means danger. Read the comment carefully. Usually it's used to say you shouldn't change the code immediately following this. It will create havoc.
 
-### Advanced Configuration
+### FAQ
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+<details>
+    <summary>Do I need to install `yarn` or `npm` would do?</summary>
+    <p>You don't really need yarn. Just use npm if you like.</p>
+</details>
 
-### Deployment
+<details>
+    <summary>Which browser should I use?</summary>
+    <p>This tutorial has been tested in Chrome only so I highly recommend you use Chrome.</p>
+</details>
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+<details>
+    <summary>Which code editor should I use for exercise?</summary>
+    <p>Anything really (Sublime, Atom, VS Code, IntelliJ) - its your preference.</p>
+</details>
 
-### `npm run build` fails to minify
+<details>
+    <summary>I accidently deleted something in exercise that I shouldn't have. What should I do?</summary>
+    <p>The easiest way is to just revert back to the previous version on your editor. If you want to start anew, then just checkout that particular file from github again using something like:<pre><code>git checkout HEAD --  exercise/01-helloWorld.js</code></pre>
+    </p>
+</details>
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+## Contribution
+
+If you went through the exercise and saw some inconsistencies or if you have an idea to make the overall tutorial better please feel free to open a PR.

package.json

@@ -2,16 +2,30 @@
   "name": "learn-react-app",
   "version": "0.1.0",
   "private": true,
+  "proxy": "https://financialmodelingprep.com",
   "dependencies": {
+    "@material-ui/core": "^3.9.0",
+    "@material-ui/icons": "^3.0.2",
+    "classnames": "^2.2.6",
+    "highlight.js": "^9.13.1",
+    "lodash": "^4.17.11",
+    "prop-types": "^15.6.2",
     "react": "^16.7.0",
+    "react-addons-shallow-compare": "^15.6.2",
     "react-dom": "^16.7.0",
-    "react-scripts": "2.1.3"
+    "react-lowlight": "^2.0.0",
+    "react-markdown": "^4.0.6",
+    "react-router": "^4.3.1",
+    "react-router-dom": "^4.3.1",
+    "react-scripts": "2.1.3",
+    "styled-components": "^4.1.3"
   },
   "scripts": {
-    "start": "react-scripts start",
+    "start": "npm run build:markdown && react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "build:markdown": "node scripts/processMarkdown"
   },
   "eslintConfig": {
     "extends": "react-app"
@@ -21,5 +35,8 @@
     "not dead",
     "not ie <= 11",
     "not op_mini all"
-  ]
+  ],
+  "devDependencies": {
+    "chalk": "^2.4.2"
+  }
 }

public/index.html

@@ -22,7 +22,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React App</title>
+    <title>Learn React App</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

scripts/processMarkdown.js

@@ -0,0 +1,60 @@
+var fs = require('fs');
+var path = require('path');
+var chalk = require('chalk');
+
+const TUTORIAL_PATH = 'src/tutorial';
+const TUTORIAL_BUILD_PATH = 'src/tutorial/build';
+const MARKDOWN_FILE_EXTENSION = 'md';
+
+function cleanBuildFolder(){
+    fs.readdir(TUTORIAL_BUILD_PATH, function (err, items) {
+        items.forEach(function(file) {
+            var filePath = path.join(TUTORIAL_BUILD_PATH, file);
+            fs.unlink(filePath, function(err) {
+                if (err) {
+                    console.log(chalk.red(`Error when deleting file %s`), filePath);
+                    throw new Error(err);
+                }
+                console.log(chalk.yellow(`Deleted file - %s`), filePath);
+            })
+        })
+    });
+}
+
+
+function createJSFilesFromMarkdown(){
+    fs.readdir(TUTORIAL_PATH, function(err, items) {
+        items.forEach(function(file) {
+            var filePath = path.join(TUTORIAL_PATH, file);
+            fs.stat(filePath, function(err, stats) {
+                if (stats.isFile() && isFileOfExtension(file, MARKDOWN_FILE_EXTENSION)) {
+                    fs.readFile(filePath, 'utf-8', function(err, data) {
+                        const newFileName = getFileNameWithoutExtension(file) + '.js';
+                        const newFilePath = path.join(TUTORIAL_BUILD_PATH, newFileName);
+                        const dataToWrite = `export default \` ${data.replace(/`/g, '\\\`')} \``;
+                        fs.writeFile(newFilePath, dataToWrite, function(err) {
+                            if (err) {
+                                console.log(chalk.red(`Error writing file  - %s`), newFilePath);
+                                throw new Error(err);
+                            }
+                            console.log(chalk.green(`File sucessfully created - %s`), newFilePath);
+
+                        })
+                    })
+                }
+            })
+        })
+    });
+}
+
+function getFileNameWithoutExtension(filename) {
+    return filename.split('.').slice(0, -1).join('.');
+}
+
+function isFileOfExtension(filename, extension) {
+    return filename.split('.').slice(-1)[0] === extension;
+}
+
+cleanBuildFolder();
+createJSFilesFromMarkdown();
+

src/App.css

@@ -1,26 +1,26 @@
 import React, { Component } from 'react';
-import logo from './logo.svg';
-import './App.css';
+import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
+
+import Tutorial from './setup/Tutorial';
+import Home from './setup/Home';
+import ScrollToTop from './setup/ScrollToTop';
 
 class App extends Component {
   render() {
     return (
-      <div className="App">
-        <header className="App-header">
-          <img src={logo} className="App-logo" alt="logo" />
-          <p>
-            Edit <code>src/App.js</code> and save to reload.
-          </p>
-          <a
-            className="App-link"
-            href="https://reactjs.org"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            Learn React
-          </a>
-        </header>
-      </div>
+      <Router>
+        <ScrollToTop>
+          <div>
+            <div className="App">
+              <Switch>
+                <Route exact path="/" component={Home} />
+                <Route path="/tutorial/:tutorial" component={Tutorial} />
+                <Route component={Home} />
+              </Switch>
+            </div>
+          </div>
+        </ScrollToTop>
+      </Router>
     );
   }
 }

src/App.js

@@ -0,0 +1,9 @@
+class FileReader {
+    readFile(fileLocation) {
+        let _fileLocation = fileLocation.replace('src', '.').replace('.js', '');
+        return import(`${_fileLocation}`)
+                .then(data => data.default);
+    }
+}
+
+export default new FileReader();