https://github.com/bstaruk/starbase-react

🌌 starbase-react is a production-ready Typescript, React, Redux Toolkit & Emotion boilerplate.
https://github.com/bstaruk/starbase-react

create-react-app create-react-app-typescript emotion eslint husky lint-staged prettier react redux redux-saga redux-toolkit testing-library typescript

Last synced: about 2 months ago
JSON representation

🌌 starbase-react is a production-ready Typescript, React, Redux Toolkit & Emotion boilerplate.

• Host: GitHub
• URL: https://github.com/bstaruk/starbase-react
• Owner: bstaruk
• License: mit
• Created: 2017-07-14T21:39:42.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-10-03T13:13:40.000Z (over 2 years ago)
• Last Synced: 2024-11-30T08:05:20.529Z (about 2 months ago)
• Topics: create-react-app, create-react-app-typescript, emotion, eslint, husky, lint-staged, prettier, react, redux, redux-saga, redux-toolkit, testing-library, typescript
• Language: TypeScript
• Homepage: https://react.starbase.dev
• Size: 1.96 MB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# starbase-react

[![dependencies status](https://david-dm.org/bstaruk/starbase-react/status.svg)](https://david-dm.org/bstaruk/starbase-react)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbstaruk%2Fstarbase-react.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbstaruk%2Fstarbase-react?ref=badge_shield)

starbase-react is a production-ready Typescript, React, Redux Toolkit & Emotion boilerplate. Brewed with [Create React App](https://github.com/facebook/create-react-app) ([v5.0.1](https://github.com/facebook/create-react-app/releases/tag/v5.0.1) w/ [TypeScript template](https://create-react-app.dev/docs/adding-typescript)), then sweetened with:

- formatting via [EditorConfig](https://editorconfig.org) & [Prettier](https://prettier.io)

- linting via & [ESLint](https://eslint.org)

- pre-commit linting and formatting via [husky](https://typicode.github.io/husky) & [lint-staged](https://github.com/okonet/lint-staged)

- a modern redux implementation via [Redux Toolkit](https://redux-toolkit.js.org) & [Redux-Saga](https://redux-saga.js.org)

- css-in-js with global styles and a theme via [Emotion](https://emotion.sh)

- ...and more!

starbase-react is a spin on [starbase](https://github.com/bstaruk/starbase). It's intended to be relatively small in scope so that it may be easily extended and customized, or used as a learning tool for folks who are trying to become familiar with Typescript, React 16, Redux Toolkit, Redux-Saga, Emotion, Testing Library, etc.

## Getting Started

After completing the steps below, you will be ready to begin using starbase-react:

1. Install [Node.js](https://nodejs.org) (latest LTS recommended)

2. Clone starbase-react into your project root directory

3. Install dependencies by running `npm install` in your project root directory

## Developing, Testing & Building

### Local Development

`npm run start` serves the app locally at [http://localhost:3000](http://localhost:3000).

### Running Tests

`npm run test` tests the app.

### Building for Production

`npm run build` builds the app to `dist`.

## License

starbase-react is open source and free software, so you may to do whatever you wish with it -- commercially or personally. You can buy me a beer next time you're in Boston, star the project and tell a friend, or you can erase all signs of origin and tell your coworkers that you made it yourself. It's all good!