Skip to content

Commit e7b8ad2

Browse files
committed
readme
1 parent 3a73c5a commit e7b8ad2

File tree

2 files changed

+58
-7
lines changed

2 files changed

+58
-7
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create Micro React App [![Build Status](https://travis-ci.com/matheusmr13/create-microfrontend-react-app.svg?branch=master)](https://travis-ci.com/matheusmr13/create-microfrontend-react-app) [![Build Status](https://dev.azure.com/matheusmr13/create-microfrontend-react-app/_apis/build/status/matheusmr13.create-microfrontend-react-app?branchName=master)](https://dev.azure.com/matheusmr13/create-microfrontend-react-app/_build/latest?definitionId=2&branchName=master) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=matheusmr13_create-microfrontend-react-app&metric=alert_status)](https://sonarcloud.io/dashboard?id=matheusmr13_create-microfrontend-react-app)
1+
# :sparkles: Create Micro React App [![Build Status](https://travis-ci.com/matheusmr13/create-microfrontend-react-app.svg?branch=master)](https://travis-ci.com/matheusmr13/create-microfrontend-react-app) [![Build Status](https://dev.azure.com/matheusmr13/create-microfrontend-react-app/_apis/build/status/matheusmr13.create-microfrontend-react-app?branchName=master)](https://dev.azure.com/matheusmr13/create-microfrontend-react-app/_build/latest?definitionId=2&branchName=master) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=matheusmr13_create-microfrontend-react-app&metric=alert_status)](https://sonarcloud.io/dashboard?id=matheusmr13_create-microfrontend-react-app)
22

33
<img align="right" src="icon.png" width="23%">
44

@@ -11,19 +11,19 @@ Most complete approach to microfrontend architecture:
1111

1212
If you want to know more about microfrontends and why you should (or shouldn't) use it, check [this article](https://matheusmr13.github.io/create-micro-react-app/docs/core/microfrontend).
1313

14-
## Quick Overview
14+
## :zap: Quick Overview
1515

1616
```
1717
npx @cmra/cli create my-app
1818
cd my-app
1919
npm start
2020
```
2121

22-
## Demo
22+
## :rocket: Demo
2323

2424
Microfrontend Store: [Demo](https://github.com/matheusmr13/micro-store)
2525

26-
## Installing
26+
## :floppy_disk: Installing
2727

2828
To install our cli you need **Node >= 13**.
2929

@@ -39,7 +39,7 @@ To install our cli you need **Node >= 13**.
3939
yarn global add @cmra/cli
4040
```
4141

42-
## Using it
42+
## :computer: Using it
4343

4444
After installing it, you'll have `cmra` command available:
4545

@@ -98,11 +98,15 @@ It will generate a folder structure like:
9898
└── yarn.lock
9999
```
100100

101-
## Development
101+
## :hammer: Development
102102

103103
First of all, check our [contributing guide](https://github.com/matheusmr13/create-micro-react-app/blob/master/CONTRIBUTING.md).
104104
If you have any questions just [open an issue](https://github.com/matheusmr13/create-micro-react-app/issues/new)!
105105

106+
## :books: Docs
107+
108+
https://matheusmr13.github.io/create-micro-react-app/docs/
109+
106110
---
107111

108112
Icon made by [Freepik](https://www.flaticon.com/authors/freepik) from [www.flaticon.com](https://www.flaticon.com/)

packages/doc/docs/getting-started.mdx

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,51 @@ With this simple commands you can create your application containing one simple
2323

2424
## Folder structure
2525

26-
<TodoTag />
26+
```bash
27+
my-app
28+
├── package.json
29+
├── packages
30+
| ├── microfrontend # create-react-app structure folder
31+
| | ├── README.md
32+
| | ├── package.json
33+
| | ├── public
34+
| | | ├── favicon.ico
35+
| | | ├── index.html
36+
| | | ├── logo192.png
37+
| | | ├── logo512.png
38+
| | | ├── manifest.json
39+
| | | └── robots.txt
40+
| | ├── src
41+
| | | ├── App.css
42+
| | | ├── App.js
43+
| | | ├── App.test.js
44+
| | | ├── index.css
45+
| | | ├── index.js
46+
| | | ├── logo.svg
47+
| | | ├── serviceWorker.js
48+
| | | └── setupTests.js
49+
| | └── yarn.lock
50+
| └── webapp # create-react-app structure folder
51+
| ├── README.md
52+
| ├── package.json
53+
| ├── public
54+
| | ├── favicon.ico
55+
| | ├── index.html
56+
| | ├── logo192.png
57+
| | ├── logo512.png
58+
| | ├── manifest.json
59+
| | ├── microfrontends
60+
| | | └── meta.json
61+
| | └── robots.txt
62+
| ├── src
63+
| | ├── App.css
64+
| | ├── App.js
65+
| | ├── App.test.js
66+
| | ├── index.css
67+
| | ├── index.js
68+
| | ├── logo.svg
69+
| | ├── serviceWorker.js
70+
| | └── setupTests.js
71+
| └── yarn.lock
72+
└── yarn.lock
73+
```

0 commit comments

Comments
 (0)