Skip to content

Commit 88e871b

Browse files
author
codesbiome
committed
Added readme and changelog
1 parent 2ff09b2 commit 88e871b

File tree

2 files changed

+102
-0
lines changed

2 files changed

+102
-0
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Change Log
2+
3+
All notable changes to the project are listed here.
4+
5+
### v1.0.0
6+
7+
- Default `Application` component and layout styles.
8+
- 🔥 Hot Module Replacement patch.
9+
- Support for `TypeScript` usage.
10+
- Support for `font` assets loading.
11+
- Support for `image` assets loading.
12+
- Linting via `ESLint`.
13+
- `Less` stylesheet webpack loader.
14+
- Webpack configuration common helpers.
15+
- `CSS` extraction using webpack for `production` builds.
16+
- Custom `@` webpack aliases for project use.
17+
- Separate `Webpack` configurations for `development` and `production` environments.

README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# React Webpack Typescript - Boilerplate (2021)
2+
3+
Minimal boilerplate for writing Web Applications using React, Webpack & TypeScript. This project makes use of latest packages like `react`, `typescript` & `webpack` to serve the best environment for development.
4+
5+
## Screenshot
6+
7+
<img src="assets/images/screenshot.png" />
8+
9+
<br>
10+
11+
## Core Features
12+
13+
- ⚛️ React
14+
- 🌀 TypeScript
15+
- 🛶 LESS Loader
16+
- 🎨 CSS Loader
17+
- 📸 Image Loader
18+
- 🆎 Font Loader
19+
- 🧹 ESLint
20+
- 🔱 Webpack & Configuration
21+
- 🧩 Aliases for project paths
22+
- 🔥 Hot Module Replacement (Live Reload)
23+
24+
<br />
25+
26+
## Installation
27+
28+
#### To install this boilerplate you need to run following commands
29+
30+
Clone the repository on your hard drive :
31+
32+
```bash
33+
git clone https://github.com/codesbiome/react-webpack-typescript-2021
34+
35+
cd react-webpack-typescript-2021
36+
```
37+
38+
Install dependencies using Yarn or NPM :
39+
40+
```bash
41+
yarn install
42+
```
43+
44+
<br />
45+
46+
## Start : Development
47+
48+
To develop and run your web application, you need to run following command :
49+
50+
```bash
51+
yarn start
52+
```
53+
54+
<br />
55+
56+
## Lint : Development
57+
58+
To lint application source code using ESLint via this command :
59+
60+
```bash
61+
yarn lint
62+
```
63+
64+
<br />
65+
66+
## Package : Production
67+
68+
Customize and package your Electron app with OS-specific bundles (.app, .exe etc)
69+
70+
```bash
71+
yarn package
72+
```
73+
74+
<br />
75+
76+
## Webpack Configurations
77+
78+
To make it easier for managing environment based webpack configurations, we using separated `development` and `production` configuration files, they are available in :
79+
80+
```bash
81+
tools/webpack/webpack.config.dev.js
82+
tools/webpack/webpack.config.prod.js
83+
```
84+
85+
For further information, you can visit [Webpack Configuration](https://webpack.js.org/configuration/)

0 commit comments

Comments
 (0)