Skip to content

Commit 2c4d0f2

Browse files
committed
docs(README): add some content
features, status badge and changelog link
1 parent 983631b commit 2c4d0f2

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
# react-stack
1+
# React Stack
2+
3+
![Lint, Test and Build](https://github.com/stackr23/react-stack/actions/workflows/github-action-test.yml/badge.svg)
4+
[![Semantic Versioning](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-blue.svg)](https://github.com/semantic-release/semantic-release) <br />
5+
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard - JavaScript Style Guide"></a>
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
7+
[![Conventional Commits](https://img.shields.io/badge/✔-Conventional%20Commits-blue.svg)](https://conventionalcommits.org)
8+
9+
> **perfect react stack to wrap your web app**
10+
>
11+
> see release notes at **[CHANGELOG](./CHANGELOG.md)**
12+
13+
## :sparkles: Features
14+
15+
<!--
16+
TODO: MobX, GH pages, SSR, ...
17+
18+
:card_file_box: **[MobX v5.5](https://mobx.js.org/) - observable store injection**
19+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;global stores based on observables
20+
21+
:zap: **[ExpressJS v4](http://expressjs.com/) - node-js server**
22+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;webpack-dev in dev, serverside rendering on prod
23+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**TBD -** /api and /test server
24+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**TBD -** prefetch component data
25+
26+
:rocket: **github pages deployment scripts**
27+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;initiate and push git worktree from /build to gh-pages
28+
--->
29+
30+
:package: **[Webpack v4](https://webpack.js.org/) - module bundler**
31+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;HMR, lazy load, static build, code splitting
32+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_(migration to v5 in progress)_
33+
34+
:alembic: **[Babel v7](https://babeljs.io/docs/en/index.html) - ESNext support provider**
35+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;async/await, static class properties, etc..
36+
37+
:atom_symbol: **[React v17](https://reactjs.org/) - view-controller library**
38+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Hooks and latest DOM features
39+
40+
:rotating_light: **[EsLint v7](https://eslint.org/) - code linting tool**
41+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;beautyful and error proof code
42+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**with [@stackr23/config-eslint](https://github.com/stackr23/config-eslint)**
43+
44+
:white_check_mark: **[Karma](https://github.com/karma-runner/karma) with [Mocha](https://github.com/mochajs/mocha) and [Chai](https://www.chaijs.com/)**
45+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unit tests and browser integration
46+
47+
:robot: **[Github Actions](https://github.com/features/actions)**
48+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for automated release process by
49+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[Conventional Commits](https://conventionalcommits.org) and [semantic-release](https://github.com/semantic-release/semantic-release)**

0 commit comments

Comments
 (0)