Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucasbassetti/react-typescript-antd-boilerplate

:fire: React Ant Design Boilerplate with TypeScript
https://github.com/lucasbassetti/react-typescript-antd-boilerplate

antdesign boilerplate react redux stylelint tslint typescript

Last synced: 7 days ago
JSON representation

:fire: React Ant Design Boilerplate with TypeScript

Awesome Lists containing this project

README

        

# React TypeScript Ant Design Boilerplate

React Boilerplate using TypeScript and Ant Design. This boilerplate uses [Create React App](https://github.com/facebook/create-react-app)

## Features

- TypeScript language
- LESS for styling
- Airbnb's JavaScript (ES6) style guide.
- TSlint for TypeScript and StyleLint for LESS
- Prettier for code formatter
- Ant Design as UI framework
- React hooks

## Components

- [Antd](https://ant.design/) as UI framework.
- [Jest](https://jestjs.io/) as as test framework.
- [LESS](http://lesscss.org/) as CSS preprocessing.
- [Prettier](https://prettier.io/) for code formatter.
- [React](https://facebook.github.io/react/) as front-end view library.
- [Redux](https://redux.js.org/) for state container.
- [Redux-Saga](https://github.com/redux-saga/redux-saga) to fetching asynchronous data with redux.
- [StyleLint](https://stylelint.io/) for LESS linting.
- [TSlint](https://palantir.github.io/tslint/) for TypeScript linting using Airbnb's JS style guide.
- [TypeScript](https://www.typescriptlang.org/) as main language.

## Getting Start

Run the following commands in your terminal

```bash
git clone https://github.com/LucasBassetti/react-typescript-antd-boilerplate.git
cd react-typescript-antd-boilerplate
yarn install
yarn start
```

Then open [http://localhost:3000/](http://localhost:3000/) on your web browser.

### Testing

1. Run `npm test` for test.

## Deploying

For deployment, run `npm run build` and upload `build/` to your server.

## License

MIT · [Lucas Bassetti](http://lucasbassetti.com.br)