Skip to content

Commit 9bf45b4

Browse files
committed
Upgrade dependencies and update and link README.
1 parent 7665fb1 commit 9bf45b4

File tree

9 files changed

+91
-714
lines changed

9 files changed

+91
-714
lines changed

README.md

Whitespace-only changes.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
packages/reactful/README.md

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"lerna": "2.4.0",
33
"packages": ["packages/*"],
4-
"version": "2.0.4"
4+
"version": "2.0.5"
55
}

package.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
{
22
"private": true,
33
"license": "MIT",
4-
"scripts": {
5-
"format": "prettier-eslint \"packages/**/src/**/*.js\" \"src/**/*.scss\" --write"
6-
},
74
"devDependencies": {
85
"babel-eslint": "latest",
96
"eslint": "latest",
107
"eslint-plugin-react": "latest",
118
"eslint-plugin-react-hooks": "latest",
129
"lerna": "latest",
13-
"lodash": "latest",
14-
"prettier": "latest",
15-
"prettier-eslint-cli": "latest"
10+
"prettier": "latest"
1611
}
1712
}

packages/reactful/.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
.DS_Store

packages/reactful/README.md

Lines changed: 32 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,58 @@
11
## Reactful
22

3-
An opinionated CLI for full-stack server-rendered React applications.
4-
You can use it to generate an independent React application that's
5-
fully-configured to render on both client and server.
3+
An opinionated CLI for full-stack server-rendered React applications. You can use it to generate an independent React application that's fully-configured to render on both client and server.
64

75
[![npm version](https://badge.fury.io/js/reactful.svg)](https://badge.fury.io/js/reactful)
86

97
This CLI requires Node >= 8.x.
108

11-
### Create New React App
9+
### Creating New App
1210

13-
npx reactful my-awesome-react-app
11+
```sh
12+
npx reactful my-awesome-react-app
13+
```
1414

15-
Once created, you'll see instructions on how to start it:
15+
Once created, you'll see instructions on how to use it:
1616

17-
cd my-awesome-react-app
17+
```sh
18+
cd my-awesome-react-app
1819

19-
### To start the app (for development):
20-
npm start
20+
# To start the app for development (watchers for node/webpack)
21+
npm start
2122

22-
# The start command starts a watcher process
23-
# which will restart node/webpack on save
23+
# To open the app in browser (default is localhost:4242)
24+
npx reactful open
2425

25-
### Open the app in browser:
26-
npx reactful open
26+
# To run all tests
27+
npm test
2728

28-
# The app will be running on localhost:4242 by default
29+
# To build for production
30+
npm run build-all
2931

30-
### To run tests:
31-
npm test
32+
# To start the app for production
33+
npm run prod-start
34+
```
3235

33-
### To build for production:
34-
npm run build-all
36+
The generated app is completely independent from the reactful package. At this point you can part ways with the package and do your own thing.
3537

36-
### To start the app for production:
37-
npm run prod-start
38+
If you keep the folder structure initialized by the package, you can use a few handy commands. For example:
3839

39-
The generated app is completely independent from the reactful package. At this
40-
point you can part ways with the reactful package and do your own thing, but if
41-
you follow the patterns initialized by the package, you can use a few handy
42-
commands from the global react command.
43-
44-
### Update Existing React App
45-
46-
While in a React application that's created with this tool, you can always
47-
revert things back the default configurations with the init command. You can
48-
also use this command in an empty directory.
40+
- Create a New (Function) Component: `npx reactful c ComponentName`
41+
- Create a New Class Component: `npx reactful cc ComponentName`
42+
- Create a New Pure Component: `npx reactful pc ComponentName`
4943

50-
cd my-awesome-react-app
51-
npx reactful init
44+
All of these commands will also create a jest snapshot test for the generated component.
5245

53-
If that directory already has files, reactful will ask you if you want to
54-
override them.
46+
### Updating Existing React App
5547

56-
### Creating Components
48+
While in a React application that's created with this tool, you can always revert things back the default configurations with the init command. You can also use this command in an empty directory.
5749

58-
- Create a New Component: `npx reactful c ComponentName`
59-
- Create a New Class Component: `npx reactful cc ComponentName`
60-
- Create a New Pure Component: `npx reactful pc ComponentName`
50+
```sh
51+
cd my-awesome-react-app
52+
npx reactful init
53+
```
6154

62-
All of these commands will also create a jest snapshot test for the generated
63-
component.
55+
If that directory already has files, reactful will ask you if you want to override them.
6456

6557
### License
6658

packages/reactful/lib/dependencies.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
"eslint-plugin-react-hooks",
4141
"jest",
4242
"nodemon",
43-
"prettier-eslint-cli",
4443
"reactful"
4544
]
4645
}

packages/reactful/lib/init.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ module.exports = function reactfulInit(config) {
1212
private: true,
1313
scripts: {
1414
eslint: 'eslint "src/**/*.js"',
15-
format: 'prettier-eslint "src/**/*.js" "src/**/*.scss" --write',
1615
start: `concurrently "${pmCommand} run dev-server" "${pmCommand} run dev-bundle"`,
1716
test: 'jest',
1817

packages/reactful/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "reactful",
3-
"version": "2.0.4",
3+
"version": "2.0.5",
44
"description": "An opinionated CLI for full-stack server-rendered React applications",
55
"repository": "jscomplete/reactful",
66
"author": "Samer Buna <[email protected]>",

0 commit comments

Comments
 (0)