Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mackentoch/react-redux-graphql-apollo-bootstrap-webpack-starter

react js + redux + graphQL + Apollo + react router + hot reload + devTools + bootstrap + webpack starter
https://github.com/mackentoch/react-redux-graphql-apollo-bootstrap-webpack-starter

apollo apollo-client boilerplate bootstrap graphql nodejs postcss react react-apollo react-hot-loader-3 react-router react-router-v4 reactjs redux redux-devtools redux-devtools-extension router scaphold webpack webpack3

Last synced: 26 days ago
JSON representation

react js + redux + graphQL + Apollo + react router + hot reload + devTools + bootstrap + webpack starter

Host: GitHub
URL: https://github.com/mackentoch/react-redux-graphql-apollo-bootstrap-webpack-starter
Owner: MacKentoch
Created: 2016-10-22T12:20:32.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2019-02-08T05:00:40.000Z (over 5 years ago)
Last Synced: 2024-09-27T22:07:47.001Z (about 1 month ago)
Topics: apollo, apollo-client, boilerplate, bootstrap, graphql, nodejs, postcss, react, react-apollo, react-hot-loader-3, react-router, react-router-v4, reactjs, redux, redux-devtools, redux-devtools-extension, router, scaphold, webpack, webpack3
Language: JavaScript
Homepage: https://mackentoch.github.io/react-redux-graphql-apollo-bootstrap-webpack-starter
Size: 5.51 MB
Stars: 125
Watchers: 17
Forks: 33
Open Issues: 4
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        Full ES6+ React + React-Router + Redux + GraphQL + Apollo + Bootstrap with Hot Reload and redux-devtools STARTER

==========

> My new `React + redux project starter`. This time I add `graphQL` and `Apollo Client`.

This starter also embeds `JWT token based` `authentication` (check [Route](https://github.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/blob/master/src/front/routes/MainRoutes.js#L29) to get an example of dealing with protected routes).

![preview](./preview/preview.png)

- *webpack is as simple as possible*

- *ReactJS is written with `optimization tricks` (stateless, pure render...).*

- *`pure front-end` = server independant (use whatever you want as server: NodeJS, Rails, .NET...)*

- contains both [`SPA`](https://github.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/tree/master/src/server/SPA) and [`SSR`](https://github.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/tree/master/src/server/SSR/src) server implementation

- caching implementation with `workbox-webpack-plugin` (*so that it follows PWA path!*)

- *`redux` + `devTools` + `hot reload`= how did I developed without them before?*

- *graphQL makes API to be " `has been` "*

  - *no more struggle in redux with async thank to Apollo Client (you can even get rid of redux thunk or redux saga if you needed theses just for your asyncs. Otherwise keep them since they are nice :smile:)*

- [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension) to make developments a pure pleasure.

## New 🎉 since v3.0.0!

- Add `code splitting` by using `dynamic import` (*router level but you can extend to component level as you feel the need*)

 - *NOTE: combined with SSR server and SW for caching, this is a good start to follow PWA path!*

 - Want to know more about code splitting with SSR a React application, [read this complete beautiful article](https://marmelab.com/blog/2017/10/17/code-splitting.html) (don't forget to clap the author - no I don't even know him 😉 - but this is a really nice job)

## Detailed Content

**Front:**

- React JS (16.2.x - [github :link:](https://github.com/facebook/react))

- Redux (*as you application grows managing state will be a serious concern, save pain with Redux*)

- apollo-client 2.x (*futur of API. Learn about this beast [here in officiel website](http://dev.apollodata.com/)*)

- React-Redux 5.x (*Redux is not specific to ReactJS, you could easily use it with Angular2 for instance*)

- React-Router-Redux (*previously named react-simple-router*)

- react-router (4.x- [github :link:](https://github.com/reactjs/react-router))

- loadable-components (1.4.x [github :link:](https://github.com/smooth-code/loadable-components))

- styled-components (3.2.x- [github :link:](https://github.com/styled-components/styled-components))

- Bootstrap (3.x - [github :link:](https://github.com/twbs/bootstrap))

- React-Bootstrap ([github :link:](https://github.com/react-bootstrap/react-bootstrap))

- font-awesome ([github :link:](https://github.com/FortAwesome/Font-Awesome))

- animate.css ([github :link:](https://github.com/daneden/animate.css))

- classnames ([github :link:](https://github.com/JedWatson/classnames))

- react-motion ([github :link:](https://github.com/chenglou/react-motion))

- Webpack 4.x ([github :link:](https://github.com/webpack/webpack))

- postcss

- babel 6+ ([github :link:](https://github.com/babel/babel))

- redux-devtool-extension ([github :link:](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension))

**Tool chain:**

- babel 6+

- eslint

- hot reload

- loaders

  - `js` / `jsx`

  - css

  - json

  - images formats

  - svg and fonts formats

**tests:**

- jest

## Usage

### Prerequisite

#### Node JS version required is `>=6.x`.

*Build with node js v8.x but should be ok with node js 6.x.*

> Better use [nvm](https://github.com/creationix/nvm) to manage your Node JS versions.

### server

An Easy and fast way to get your graphql backend is to **register for free at [Scaphold](https://scaphold.io)**.

> This starter has been created with a scaphold free plan.

**Go to [Scaphold](https://scaphold.io) register and create an application**



- set `AppName`

- and a `description` (*so that after creating hundreds of applications you won't get lost*).

**You will be able to dicover predefined schemas. This starter will not need more than predefined (User):**

![schema_desiner_overview.png](https://raw.githubusercontent.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/master/print_screens/schema_desiner_overview.png)

- you can define you own schema (*not needed for this starter to run*). But I suggest you have a look on well written `tutorials` to get more familiar with the schema designer.

**GraphiQL is integrated in Scaphold so discover and train predefined graphQL queries and mutations:**

![graphiQL_overview.png](https://raw.githubusercontent.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/master/print_screens/graphiQL_overview.png)

### Configure starter application:

In Scaphold click on `My API` and `copy your application link`.

Then, past it (*to replace http://localhost:8080/graphql*) in your `networkInterface` in the app config (in `./src/front/config.index.js`):

```javascript

export const appConfig = {

  // apollo client:

  apollo: {

    networkInterface: 'http://localhost:8080/graphql'

  }

};

```

> from now you got all needed to run this starter

### Install dependencies

```bash

npm install

```

### run dev : hot reload mode (*+ redux-devtools-extension*)

```bash

npm run start

```

NOTE: be sure you already installed [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension) in your browser to get the best development experience.

### bundle dev mode (*+ redux-devtools*)

```bash

npm run dev

```

### tests

```bash

npm run test

```

### Analyze production bundle (*PWA friendly*)

```bash

npm run analyze

```

### bundle production mode

```bash

npm run prod

```

### run dev bundle

```bash

npm run start-spa-dev

```

### run prod bundle

```bash

npm run start-spa-prod

```

## Donate

Do you use & like react-redux-graphql-apollo-bootstrap-webpack-starter but you don’t find a way to show some love?

If yes, please consider donating to support this project. Otherwise, no worries, regardless of whether there is support or not, I will keep maintaining this project. Still, if you buy me a cup of coffee I would be more than happy though 😄

[![Support via PayPal](./assets/Paypal-button.png)](https://www.paypal.me/ErwanDatin/)

## License

The MIT License (MIT)

Copyright (c) 2019 Erwan DATIN

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.