Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MikeBild/racyjs
A blazing fast zero-configuration async server-side React with GraphQL toolbelt
https://github.com/MikeBild/racyjs
api apollo async graphql parceljs react reactjs server-side-rendering ssr
Last synced: 2 months ago
JSON representation
A blazing fast zero-configuration async server-side React with GraphQL toolbelt
- Host: GitHub
- URL: https://github.com/MikeBild/racyjs
- Owner: MikeBild
- License: mit
- Created: 2018-09-14T15:24:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-13T08:20:24.000Z (about 6 years ago)
- Last Synced: 2024-10-27T22:47:10.835Z (3 months ago)
- Topics: api, apollo, async, graphql, parceljs, react, reactjs, server-side-rendering, ssr
- Language: JavaScript
- Homepage:
- Size: 766 KB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
- awesome-blazingly-fast - racyjs - A blazing fast zero-configuration async server-side React with GraphQL toolbelt (JavaScript)
README
# Racy
> A blazing fast zero-configuration async server-side React with GraphQL
> toolbelt.
## Stack
- [Babel 7 + Polyfill](https://github.com/babel/babel)
- [Parcel Bundler](https://github.com/parcel-bundler/parcel/blob/master/README.md)
- [React](https://github.com/facebook/react/blob/master/README.md)
- [Styled-Components](https://github.com/styled-components/styled-components/blob/master/README.md)
- [Helmet-Async](https://github.com/staylor/react-helmet-async/blob/master/README.md)
- [React-Router v4](https://github.com/ReactTraining/react-router/blob/master/packages/react-router/README.md) +
[React-Router-DOM](https://github.com/ReactTraining/react-router/blob/master/packages/react-router-dom/README.md) +
[React-Router-Config](https://github.com/ReactTraining/react-router/blob/master/packages/react-router-config/README.md)
- [Express](https://github.com/expressjs/express/blob/master/Readme.md)
- [GraphQL](https://github.com/facebook/graphql/blob/master/README.md)
[Apollo React](https://github.com/apollographql/react-apollo/blob/master/README.md)
&
[Apollo Server](https://github.com/apollographql/apollo-server/blob/master/README.md)
## Setup
- `npm init -f`
- `yarn add racy`
_`package.json`_
```json
"scripts": {
"dev": "racy dev",
"build": "racy build",
"serve": "racy serve",
"export": "racy export",
"start": "NODE_ENV=production racy build && racy serve",
"static": "NODE_ENV=production npm run export && racy static"
}
```
## How to
- [How to create a simple React-App?](#how-to-create-a-simple-react-app)
- [How to customize the default configuration?](#how-to-customize-the-default-configuration)
- [How to map a component to a route?](#How-to-map-a-component-to-a-route)
- [How to use dynamic imports and code splitting?](#how-to-use-dynamic-imports-and-code-splitting)
- [How to use GraphQL on the client?](#how-to-use-graphql-on-the-client)
- [How to use customize Apollo links?](#how-to-use-customize-apollo-links)
- [How to extend Express with additional middleware?](#how-to-extend-express-with-additional-middleware)
- [How to create a GraphQL server?](#how-to-create-a-graphql-server)
- [How to add GraphQL subscriptions on the client?](#how-to-add-graphql-subscriptions-on-the-client)
## CLI
- `racy dev` - Develop an App
- `racy build` - Build an App for dynamically serving
- `racy serve` - Dynamically serve an App
- `racy export` - Export an App for statically serving
- `racy static` - Statically serve an App
- `racy graphql schema` - Fetch and save GraphQL schema to a file
- `racy graphql fragments` - Fetch and save GraphQL fragment types to a file
## How to create a simple React-App?
Just enter `yarn add react` and create a `App.js` in your project root folder.
_`App.js`_
```jsx
import React, { Fragment as F } from 'react';
import Helmet from 'react-helmet';
import styled from 'styled-components';
const Headline = styled.h1`
color: blue;
`;
export default async ({ name, version, port }) => (
React-App
Racy Basic App Example {name} {version}
);
```
- [React Basic Example](examples/react-basic/README.md)
## How to customize the default configuration?
Just create a `config.js` in your project root folder.
_`config.js`_
```javascript
export default {
// Listen on port?
port: process.env.PORT || 8080,
// GraphQL prefetch on server?
shouldPrefetch: false,
// SSR mode only?
ssrMode: false,
};
```
- [React Advanced Example](examples/react-advanced/README.md)
## How to map a component to a route?
- [React-Router-Config](https://github.com/ReactTraining/react-router/blob/master/packages/react-router-config/README.md)
_`App.js`_
```jsx
import React from 'react';
import Home from './components/Home';
import About from './components/About';
import NotFound from './components/NotFound';
export default async () => [
{ path: '/', exact: true, component: Home },
{ path: '/about', exact: true, component: About },
{ component: NotFound },
];
```
- [React Advanced Example](examples/react-advanced/README.md)
## How to use dynamic imports and code splitting?
_`App.js`_
```jsx
import React from 'react';
export default async () => {
const { default: Home } = await import('./components/Home');
const { default: About } = await import('./components/About');
return [
{ path: '/', exact: true, component: Home },
{ path: '/about', exact: true, component: About },
];
};
```
- [React Advanced Example](examples/react-advanced/README.md)
## How to use GraphQL on the client?
_`App.js`_
```jsx
import React, { Fragment as F } from 'react';
import { Query } from 'react-apollo';
import GITHUB_QUERY from './Github.gql';
export default async ({ name, version }) => {
return (
App: {name} {version}
{({ data, error, loading }) => {
if (loading) return loading ...;
if (error) return {error.message};
return {JSON.stringify(data, null, 4)};
}}
);
};
```
_`config.js`_
```javascript
export default {
// Listen on port
port: process.env.PORT || 8080,
// GraphQL URL for GraphQL queries
graphqlUrl: process.env.GRAPHQLURL || 'https://www.graphqlhub.com/graphql',
// Import fragment types file to resolve union and interface types
createFragmentTypes: async () => await import('./fragmentTypes.json'),
// Enable prefetching on server-side
shouldPrefetch: true,
};
```
- [React GraphQL Example](examples/react-graphql/README.md)
## How to use customize Apollo links?
_`config.js`_
```jsx
import { withClientState } from 'apollo-link-state';
import resolvers from './resolvers';
export default {
port: process.env.PORT || 8080,
createLink: async ({ cache }) =>
withClientState({
cache,
resolvers,
defaults: {
visible: false,
},
}),
};
```
- [React GraphQL Link Example](examples/react-graphql-link/README.md)
## How to extend Express with additional middleware?
Just create a `express-server.js` in your project root folder.
_`express-server.js`_
```javascript
import morgan from 'morgan';
import cors from 'cors';
import compression from 'compression';
import examples from './examples';
export default ({ config, app }) => {
app.use(morgan('combined'));
app.use(cors());
app.use(compression());
app.use('/api/examples', examples);
};
```
- [Express Middleware Example](examples/express-server/README.md)
## How to create a GraphQL server?
Just create a `graphql-server.js` in your project root folder.
_`graphql-server.js`_
```javascript
export default ({ config }) => ({
context: ({ req }) => ({ req, config }),
typeDefs: `type Todo {
id: ID!
description: String!
done: Boolean
}
type Query {
todos: [Todo]
}`,
resolvers: {
Query: {
todos: () => [{ id: 1, description: 'Demo 1', done: false }],
},
},
});
```
- [GraphQL Server Example](examples/graphql-server/README.md)
## How to add GraphQL subscriptions on the client?
_`config.js`_
```jsx
import { split } from 'apollo-link';
import { HttpLink } from 'apollo-link-http';
import { WebSocketLink } from 'apollo-link-ws';
import { getMainDefinition } from 'apollo-utilities';
export default {
port: 8080,
createLink,
};
function createLink({ isServer }) {
const httpLink = new HttpLink({
uri: `http://localhost:8080/graphql`,
});
const wsLink = isServer
? null
: new WebSocketLink({
uri: `ws://localhost:8080/graphql`,
options: {
reconnect: true,
},
});
return isServer
? httpLink
: split(
({ query }) => {
const { kind, operation } = getMainDefinition(query);
return kind === 'OperationDefinition' && operation === 'subscription';
},
wsLink,
httpLink,
);
}
```
_`App.js`_
```jsx
import React, { Fragment as F } from 'react';
import { Subscription } from 'react-apollo';
import gql from 'graphql-tag';
const GRAPHQL_SUBSCRIPTION = gql`
subscription OnChanged {
changed {
id
name
}
}
`;
export default async () => (
{({ data }) =>
{JSON.stringify(data, null, 2)}}
);
```
- [GraphQL Subscription Example](examples/react-graphql-subscription/README.md)