Skip to content

Commit dba67c4

Browse files
committed
Merge branch 'develop'
2 parents 0669159 + 37216bd commit dba67c4

File tree

3 files changed

+43
-15
lines changed

3 files changed

+43
-15
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/UruIT/react-seed/develop/LICENSE)
44
[![Build Status](https://travis-ci.org/UruIT/react-seed.svg)](https://travis-ci.org/UruIT/react-seed?branch=master)
5-
5+
[![GitHub release](https://img.shields.io/github/release/uruit/react-seed.svg)](https://github.com/UruIT/react-seed/releases)
6+
[![Twitter Follow](https://img.shields.io/twitter/follow/uruit.svg?style=social&label=Follow)](https://twitter.com/UruIT/followers)
7+
[![Twitter URL](https://img.shields.io/twitter/url/http/uruit.react-seed.svg?style=social)](https://twitter.com/intent/tweet?text=react-seed%20by%20%40UruIT%20on&url=https%3A%2F%2Fgithub.com%2Furuit%2Freact-seed)
68

79
UruIT seed project for ReactJS applications
810

@@ -26,6 +28,7 @@ UruIT seed project for ReactJS applications
2628
* Redux
2729
* Redux-Segment
2830
* MongoDB
31+
* MSSQL
2932
* i18n
3033
* PDF
3134

@@ -37,6 +40,7 @@ master *
3740
seed/
3841
./redux
3942
./mongo
43+
./mssql
4044
./redux-i18n
4145
./i18n
4246
```
@@ -47,6 +51,29 @@ seed/
4751
* storybook
4852
* bootstrap
4953

54+
## Structure
55+
56+
```
57+
app
58+
├── client
59+
│ ├── components
60+
│ │ └── home
61+
│ ├── config
62+
│ │ └── webpack
63+
│ ├── routes
64+
│ ├── styles
65+
│ └── utils
66+
├── docs
67+
└── server
68+
├── config
69+
├── datastore
70+
├── exceptions
71+
├── routes
72+
├── services
73+
├── tests
74+
└── utils
75+
```
76+
5077
## Development
5178

5279
Restore all packages and start development server:

docs/setup.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33
## Install dependencies
44

5-
Restore all packages
5+
Restore all packages from root folder:
66

77
```bash
8-
yarn # root folder
8+
$ yarn # or (yarn install)
99
```
1010

11-
1211
## Database
1312

1413
* Install [postgres](https://www.postgresql.org/) and [pgAdmin](https://www.pgadmin.org/)
@@ -29,13 +28,13 @@ yarn # root folder
2928
#### Development (with nodemon)
3029

3130
```bash
32-
yarn run dev
31+
$ yarn dev # or (yarn run dev)
3332
```
3433

3534
#### Production
3635

3736
```bash
38-
yarn run prod # build and start
37+
$ yarn prod # build and start
3938
```
4039

4140
Open browser on [localhost:3000](http://localhost:3000/)
@@ -44,13 +43,13 @@ Open browser on [localhost:3000](http://localhost:3000/)
4443
## NPM Scripts
4544

4645
```bash
47-
yarn run build # build production assets
46+
$ yarn build # build production assets
4847

49-
yarn run start # execute production server
48+
$ yarn start # execute production server
5049

51-
yarn run test # execute all tests
50+
$ yarn test # execute all tests
5251

53-
yarn run lint # execute linting
52+
$ yarn lint # execute linting
5453
```
5554

5655
<details>
@@ -87,10 +86,11 @@ In develop we use [git hooks](https://git-scm.com/docs/githooks) for automate li
8786
Using [husky](https://github.com/typicode/husky) with `yarn`:
8887

8988
```bash
90-
yarn add husky --dev --force # ensures hooks will be installed
89+
$ yarn add husky --dev --force # ensures hooks will be installed
9190
```
9291

9392
Install hooks manually (using `node`):
93+
9494
```bash
95-
node node_modules/husky/bin/install
95+
$ node node_modules/husky/bin/install
9696
```

docs/vscode.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We encourage the use of [prettier](https://github.com/prettier/prettier) in your
1010
## Settings.json
1111

1212
```javascript
13-
// Settings we use to overwrite the default settings
13+
// Settings we use to overwrite the default ones
1414
{
1515
"editor.rulers": [120],
1616
"editor.renderWhitespace": "boundary",
@@ -20,12 +20,12 @@ We encourage the use of [prettier](https://github.com/prettier/prettier) in your
2020
"relativePath.removeExtension": true,
2121
"relativePath.removeLeadingDot": true,
2222

23-
// we use these settings with `prettier` extension
23+
// settings for `prettier` extension
2424
"prettier.singleQuote": true,
2525
"prettier.printWidth": 120,
2626
"prettier.useTabs": true,
2727
"prettier.tabWidth": 4
28-
}
28+
}
2929
```
3030

3131
## Extensions
@@ -34,3 +34,4 @@ We encourage the use of [prettier](https://github.com/prettier/prettier) in your
3434
* [Mithril Emmet](https://marketplace.visualstudio.com/items?itemName=FallenMax.mithril-emmet)
3535
* [Prettier - JavaScript formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
3636
* [Relative Path](https://marketplace.visualstudio.com/items?itemName=jakob101.RelativePath)
37+
* [UruIT React Snippets](https://marketplace.visualstudio.com/items?itemName=UruIT.uruit-react-snippets)

0 commit comments

Comments
 (0)