https://github.com/mirego/react-boilerplate

⚛ The stable base upon which we build our React projects at Mirego.
https://github.com/mirego/react-boilerplate

apollo apollo-client docker emotions graphql i18next jest prettier react react-router reactjs typescript

Last synced: 3 months ago
JSON representation

⚛ The stable base upon which we build our React projects at Mirego.

• Host: GitHub
• URL: https://github.com/mirego/react-boilerplate
• Owner: mirego
• License: bsd-3-clause
• Created: 2019-03-18T19:02:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T10:12:44.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T16:56:01.363Z (6 months ago)
• Topics: apollo, apollo-client, docker, emotions, graphql, i18next, jest, prettier, react, react-router, reactjs, typescript
• Language: TypeScript
• Homepage: https://open.mirego.com
• Size: 2.29 MB
• Stars: 58
• Watchers: 36
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

  

This repository is the stable base upon which we build our React projects at Mirego.
We want to share it with the world so you can build awesome React applications too.



## Introduction

To learn more about _why_ we created and maintain this boilerplate project, read our [blog post](https://shift.mirego.com/en/boilerplate-projects).

## Content

This boilerplate comes with batteries included, you’ll find:

- Tests with [jest](https://jestjs.io), with coverage

- Linting with [tslint](https://palantir.github.io/tslint) and [stylelint](https://stylelint.io)

- Formatting with [Prettier](https://prettier.io)

- A [GraphQL](https://graphql.org) setup powered by [Apollo](https://www.apollographql.com)

- Translations powered by [i18next](https://www.i18next.com)

- [TypeScript](https://www.typescriptlang.org)

- Styled components with [emotions](https://emotion.sh)

- Routing with [react-router](https://reacttraining.com/react-router/)

- A clean and useful `README.md` template (in both [english](./BOILERPLATE_README.md) and [french](./BOILERPLATE_README.fr.md))

## Usage

### With GitHub template

1. Click on the [**Use this template**](https://github.com/mirego/react-boilerplate/generate) button to create a new repository

2. Clone your newly created project (`git clone https://github.com/you/repo.git`)

3. Run the boilerplate setup script (`./boilerplate-setup.sh YourProjectName`)

4. Commit the changes (`git commit -a -m "Rename react-boilerplate parts"`)

### Without GitHub template

1. Clone this project (`git clone https://github.com/mirego/react-boilerplate.git`)

2. Delete the internal Git directory (`rm -rf .git`)

3. Run the boilerplate setup script (`./boilerplate-setup.sh YourProjectName`)

4. Create a new Git repository (`git init`)

5. Create the initial Git commit (`git commit -a -m "Initial commit"`)

## License

React Boilerplate is © 2018-2020 [Mirego](https://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the [`LICENSE.md`](https://github.com/mirego/react-boilerplate/blob/master/LICENSE.md) file.

The science logo is based on [this lovely icon by Igé Maulana](https://thenounproject.com/term/science/2089589), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.

## About Mirego

[Mirego](https://www.mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of [talented people](https://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://www.mirego.org).

We also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.