Skip to content

Updated README files for all projects #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 7 additions & 18 deletions 01-scaffolding/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,13 @@
# 01 Scaffolding
# 01 Ext JS to React: Scaffolding

This subdirectory contains an app already generated with create-react-app, as
described in the Scaffolding blog post (link here)
This directory contains an example of a sample React application generated by [create-react-app](https://www.npmjs.com/package/create-react-app) as described in the [Scaffolding blog post](https://moduscreate.com/blog/ext-js-to-react-scaffolding/).

Make sure you have yarn installed.
Create-react-app is a great way to spin up a starter application with React and will be used extensively in this repo.

To run the app server:
## Example Projects

```
$ cd my-app
$ yarn start
```
- [my-app](./my-app): sample starter app created by create-react-app

A browser window will automatically open and will load the app.

As you make edits to the sources in the my-app/ directory, the browser will
automatically refresh to reflect your changes.

The blog post suggetss some simple edits to see this in action.

For a quick start, you can edit my-app/src/App.js and comment out one of the two
import lines, for logo.svg OR logo2.svg.
### Related Blog Article

[Ext JS to React: Scaffolding](https://moduscreate.com/blog/ext-js-to-react-scaffolding/)
26 changes: 26 additions & 0 deletions 01-scaffolding/my-app/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
This project was generated as a sample React application using [create-react-app](https://www.npmjs.com/package/create-react-app) as described in the [Scaffolding](https://moduscreate.com/blog/ext-js-to-react-scaffolding/) blog post.

# my-app

This project contains a simple modification to the initially generated starter app. It serves to demonstrate how to edit files within the starter app and see the changes update in the browser real-time (when following the steps outlined in the [Scaffolding blog article](https://moduscreate.com/blog/ext-js-to-react-scaffolding/)).

*Make sure you have npm installed.*

To run the app server:

```
$ npm install
$ npm start
```

A browser window will automatically open and will load the app.

As you make edits to the sources in the my-app/ directory, the browser will automatically refresh to reflect your changes.

The blog post suggests some simple edits to see this in action.

For a quick start, you can edit `my-app/src/App.js` and comment out one of the two import lines: `logo.svg` or `logo2.svg`.


# Create React App README

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

Below you will find some information on how to perform common tasks.<br>
Expand Down
3 changes: 2 additions & 1 deletion 01-scaffolding/my-app/src/App.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React, { Component } from 'react';

//import logo from './logo.svg';
// import logo from './logo.svg';
// replace the original logo from the generated app with one we'll supply
import logo from './logo2.svg';
import './App.css';

Expand Down
14 changes: 9 additions & 5 deletions 02-instantiation/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# 02 Instantiation
# 02 Ext JS to React: Class Instantiation and Code Style

This subdirectory contains an app already generated with create-react-app, as
described in the Instantiation blog post (link here). The source code has been
modified to include the examples in the blog post so you can see it in action.
React components can be created a couple of different ways. The [my-app](./my-app) example project demonstrates how React components may be instantiated.

See my-app/src/App.js
## Example Projects

- [my-app](./my-app): sample app demonstrating how React components are instantiated

### Related Blog Article

[Ext JS to React: Class Instantiation and Code Style](https://moduscreate.com/blog/extjs-react-class-instantiation-code-style/)

20 changes: 20 additions & 0 deletions 02-instantiation/my-app/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
This project was generated as a sample React application using [create-react-app](https://www.npmjs.com/package/create-react-app) as described in the [Scaffolding](https://moduscreate.com/blog/ext-js-to-react-scaffolding/) blog post.

# my-app

This project contains an example `MyHeader` component which is instantiated within the `MyComponent` class. The `MyComponent` is then instantiated by the `App` component exported from `my-app/src/App.js`.

*Make sure you have npm installed.*

To run the app server:

```
$ npm install
$ npm start
```

A browser window will automatically open and will load the app.


# Create React App README

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

Below you will find some information on how to perform common tasks.<br>
Expand Down
Loading