You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 6, 2022. It is now read-only.
### Many fixes, updates and maintenances...
**Changes:**
- Synched with the `dev` of the original boilerplate
- Fixed tree-shaking issues
- Fixed `internal/scripts` for setup and cleaning
- Updated version to `4.1`
- Updated docs to contain typescript-only documentation
- Improved `internals/scripts/generate-templates-for-linting.js` script
- Added `babel-loader` after `ts-loader`
- Updated `README`
- Updated package versions and fixed the new versions' problems
Copy file name to clipboardExpand all lines: README.md
+47-47Lines changed: 47 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,19 +84,17 @@
84
84
85
85
</div>
86
86
87
-
This is the **TYPESCRIPT** implementation of the original [react-boilerplate](https://github.com/react-boilerplate/react-boilerplate) with extra features and powers of `Typescript`
87
+
This is the **TYPESCRIPT** implementation of the original [**react-boilerplate**](https://github.com/react-boilerplate/react-boilerplate) with extra features and powers of `Typescript`
88
88
89
89
> ⚠️ Please refer to the [react-boilerplate](https://github.com/react-boilerplate/react-boilerplate) for the details and the documentation
* Typescript practices heavily depends on the guide -> <ahref="https://github.com/piotrwitek/react-redux-typescript-guide">react-typescript-guide</a>
97
+
- For the detailed documentation: [**Typescript Docs**](docs/README.md)
100
98
101
99
- Example projects built with this boilerplate `(if you are looking for advanced examples)`:
102
100
@@ -110,11 +108,32 @@ Boilerplate version: `4.1`
110
108
111
109
## Getting Started & Features & Documentations and More...
112
110
113
-
⚠️
114
-
Refer to the [react-boilerplate](https://github.com/react-boilerplate/react-boilerplate)
111
+
You can find all the documentation in the original [**react-boilerplate**](https://github.com/react-boilerplate/react-boilerplate)
112
+
113
+
For the typescript related documentation: [**Typescript Docs**](docs/README.md)
114
+
115
+
## Quick start
116
+
117
+
1. Make sure that you have Node.js v10.13.0 and npm v6.4.1 or above installed.
118
+
2. Clone this repo using `git clone --depth=1 https://github.com/react-boilerplate/react-boilerplate-typescript.git <YOUR_PROJECT_NAME>`
119
+
3. Move to the appropriate directory: `cd <YOUR_PROJECT_NAME>`.<br />
120
+
4. Run `npm run setup` in order to install dependencies and clean the git repo.<br />
121
+
_At this point you can run `npm start` to see the example app at `http://localhost:3000`._
122
+
5. Run `npm run clean` to delete the example app.
123
+
124
+
Now you're ready to rumble!
115
125
116
126
---
117
127
128
+
## Ongoing Work
129
+
130
+
In between [releases](https://github.com/react-boilerplate/react-boilerplate-typescript/releases), we work on the `dev` branch and rarely ever update `master`. For that reason, it sometimes look like the repo isn't actively maintained. This isn't the case, React Boilerplate is alive and kicking.
131
+
132
+
Please feel free to check out:
133
+
134
+
- our [`dev` branch](https://github.com/react-boilerplate/react-boilerplate-typescript/tree/dev) for the latest updates. You are always welcome to use it as the basis for your project. We only merge to `dev` projects which are fully ready.
135
+
- our open [issues](https://github.com/react-boilerplate/react-boilerplate/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and [pull requests](https://github.com/react-boilerplate/react-boilerplate/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) to see what we are currently working on. Suggestions and contributions are always welcome!
@@ -143,50 +162,31 @@ This project follows the [all-contributors](https://github.com/all-contributors/
143
162
144
163
This project would not be possible without the support of these amazing folks. [**Become a sponsor**](https://opencollective.com/react-boilerplate) to get your company in front of thousands of engaged react developers and help us out!
0 commit comments