These are the files from the webinar provided by Wintellect. If you are interested in more training on GraphQL & Relay, please click here.
This is a starter project for creating an HTML/SASS/React/Redux/Relay application.
Step 0. Please completely read and thoroughly understand the instructions below before performing them.
Step 1. Download Install Node.js version 7 or higher. Version 7 or higher MUST be installed. If you have an older Node.js version that you need to keep, then use something like NVM to manage multiple Node.js installations. To install Node.js click here.
Note: Seriously, please use Node version 7 or higher. There are certain features such as destructuring and spreads which will not work with earlier versions of Node.js. If you use an earlier version your code will fail.
Step 2. Download the repository as a zip file. Extract the zip file to a working folder on your system.
Step 3. Open a new terminal window, change to the folder where you extracted the zip file. You should see a package.json file in the folder.
On Windows, the terminal is called "Node.js Command Prompt". This will command prompt will contain the proper paths for Node.js development. DO NOT RUN the Node.js program. Click the icon named "Node.js Command Prompt". For Mac users, the Mac terminal is all you need.
Step 4. From the terminal, run the following command:
npm i && npm startIt will take a few minutes for this command to complete. If you have connection issues due to a proxy server, please edit the .npmrc file per the instructions in that file. Then re-run the command above.
This set has been completed successfully when you receive the following message:
web server running on port 3000
please do not close this terminal window
please use a new terminal window to run additional commandsThis terminal window is now running the web server, a second terminal window will need to be opened to run additional terminal commands.
Step 5. Open a web browser, and navigate to http://localhost:3000. The starter web application should load and be usable.
Step 6. Open a new terminal window (do not use the same terminal window as the web server), change to the project folder.
Step 7. From the terminal, run the following command:
npm run webpackNote: This command will run, and then wait for file changes to process updated source code from the src folder. Webpack does NOT exit and return to a terminal prompt. Please do not close this terminal window.
Step 8. Open your favorite text editor (such as Atom or Visual Studio Code), and modify the files in the src/www folder. When file changes are saved, webpack will automatically transpile and bundle the application code and assets, and deploy it to the dist folder. To see the changes, reload your web browser.
Visual Studio Code supports JSX out of the box. Atom requires the react package to be installed. To install it from the menu bar, go to Packages -> Settings View -> Install Packages/Themes. Search for react, then click Install (you may need to scroll down the search results to find the package). Sometimes Atom will not be able to download the package because of proxy settings. To resolve this run the following commands from a terminal window, replacing the localhost URL with your proxy URL setting:
apm config set proxy "http://localhost:8080"
apm config set https_proxy "http://localhost:8080"
apm config set strict-ssl falseRestart Atom, then re-attempt to install the react package again.
JavaScript & HTML linting support can be added by installing the linter, linter-htmlhint, and linter-eslint packages.
While other editors support JSX and other linting features (such as IntelliJ or WebStorm), I only support Visual Studio Code and Atom in class.
From a terminal, in the root project folder (where the package.json file exists), the following commands can be executed to perform various project development tasks.
- npm start - starts the web server
- npm run clean - removes the dist folder
- npm run build - removes the dist folder, builds and deploys the server app, and the web app
- npm run webpack - runs webpack in watch mode so web app file changes are automatically processed, and deployed to the dist/www folder
- npm run webpack-once - runs webpack once to process web app files, and deploys them to the dist/www folder
- npm run server - builds the server application, and deploys it to the dist folder
- npm run update-schema - updates the GraphQL schema for RelayQL