1 | # Web Instant
|
2 |
|
3 | > Create and Run React and Redux application instantly
|
4 |
|
5 | [![Build Status][travis-badge]][travis]
|
6 |
|
7 | ## Why
|
8 |
|
9 | - *Simple* - A single line of execution empowers the fast iteration for your MVP.
|
10 | - *Instant* - Bootstrap your Web App instantly with configuration free.
|
11 | - *Powerful* - Hot Reload, CSS Modules, PostCSS, and more are ready for instant Mobile first and Offline first experience.
|
12 |
|
13 | ## Installation
|
14 |
|
15 | `npm install -g web-instant`
|
16 |
|
17 | ## Usage
|
18 |
|
19 | 1. [Create](#create)
|
20 | 2. [Generate](#generate)
|
21 |
|
22 | ### <a name="create"></a>Create
|
23 |
|
24 | Assuming the name of your Web App is `sample-app`.
|
25 |
|
26 | ```sh
|
27 | web-instant create sample-app
|
28 | ```
|
29 |
|
30 | or you can use `wi` instead.
|
31 |
|
32 | ```sh
|
33 | wi create <any name your want>
|
34 | ```
|
35 |
|
36 | ![Alt text](docs/installation.png?raw=true "installation")
|
37 |
|
38 | The creation time will take around 5 minutes long to complete since it will run async `npm install` for you.
|
39 |
|
40 | ![Alt text](docs/success.png?raw=true "success")
|
41 |
|
42 | After creation, run `cd sample-app` to navigation to the newly created project.
|
43 |
|
44 | Once a project is successfully generated, you can just simply execute:
|
45 |
|
46 | ```sh
|
47 | npm start
|
48 | ```
|
49 |
|
50 | `npm start` will also generate a build for you into `./public` folder.
|
51 |
|
52 | However, you can also build it by your own by executing:
|
53 |
|
54 | ```sh
|
55 | npm run build
|
56 | ```
|
57 |
|
58 | Assets under `./public` will be production ready.
|
59 |
|
60 | [travis]: https://travis-ci.org/yhjor1212/web-instant
|
61 | [travis-badge]: https://img.shields.io/travis/yhjor1212/web-instant.svg
|
62 |
|
63 | ### <a name="generate"></a>Generate
|
64 |
|
65 | Generator command looks like this:
|
66 | `wi generate <type> <feature> <name>`
|
67 |
|
68 | Example:
|
69 | ```sh
|
70 | wi generate component comment commentBox // ./src/comment/components/CommentBox.jsx
|
71 | ```
|
72 |
|
73 | ## Templates
|
74 |
|
75 | You may also want to take a look for the template:
|
76 |
|
77 | ```
|
78 | https://github.com/yhjor1212/web-instant-templates
|
79 | ```
|