/ReatJS-Apollo-Starter-Kit

ReactJS starter kit integrated with apollo client for GraphQL and MUI (http://www.material-ui.com/) for UI

Primary LanguageJavaScriptMIT LicenseMIT

Installation Guide for ReactJS-Apollo Simple Starter Kit.

For starting repo, follow these steps.

Requirements

Install Node v6.3.0+

Install Java JDK

Download Java JDK Here.

Install Webdriver Manager for E2E Tests

npm install
./node_modules/protractor/bin/webdriver-manager update // Download the Selenium driver

Set GraphQL Hub Endpoint

You can use https://graph.cool for setting GraphQL as a service for your project.

  • Rename ./client/config/config.dev.json.example removing the example extension.
  • Set GRAPHQL_ENDPOINT const to your GraphQL Endpoint.

Basic commands

npm start // Start the application in dev mode. Open in http://localhost:3000
npm run dev:hot // Start the application in dev mode hit hot reload implementation. Open in http://localhost:8080
npm run test // Run respective Unit tests from app
npm run deploy // Run the unit tests and e2e test, after it build the bundle. Show in http://localhost:8000

Enable Automated Documentation

For enabling automated documentation, please install esdoc via npm

npm install -g esdoc

It, enables the documentation generation running the stage or deploy commands.

For showing how to create a documentation for components or classes, please check the docs Here.

Running the Project

Finally, run the project again

npm run dev:hot