exlskills/web-client repository overview

⁠EXLskills React/Relay Web Client

⁠Requirements

You may be able to get away with more/less than what's described below, but we can't recommend anything outside of these options:

Operating Systems:

• Ubuntu 16.04
• OS X 10.13+
• Windows has not been thoroughly tested, although it has worked and should work... Windows-related contributions are welcome

Other Dependencies:

• Facebook Watchman v4.9.0+ (for relay compiler) Install Watchman⁠
• NodeJS v8.10+
• NPM v6.1+
• Yarn 1.7+

⁠Installation

git clone https://github.com/exlskills/web-client

cd web-client

yarn install

yarn run relay

⁠Environment

Setup environment variables by first copying the environment variable config template:

cp .envdefault .env

Replace default environment variables with your own (key=value). See more here⁠

⁠GraphQL Schema

The schema.graphql file comes from the GraphQL server⁠, and it is periodically copied into this repository.

In the event that you require the latest schema.graphql or you would like to test some latest changes in the GraphQL server, follow the steps prescribed below:

The snippet below assumes that you have installed the GraphQL server⁠ into ../gql-server:

cd ../gql-server

npm run update-schema

cp src/schema.graphql ../web-client

cd ../web-client

⁠Relay Objects Generation

To generate the latest required GraphQL objects, run:

yarn run relay

⁠Development

To start the relay file generator and relay watcher, run:

yarn run relay:watch

And to start the development server and webpack file watcher, run in another terminal tab/window:

yarn run start

To run the production build in dev (localhost) run:

yarn run build # to build the production chunks
NODE_ENV=production node server/index.js # serve the production build on localhost

⁠License

This software is offered under the terms outlined in the LICENSE.md⁠ file provided with this notice. If you have any questions regarding the license, please contact [email protected]⁠

⁠Enterprise / Commercial Licensing & Support

For enterprise licenses and/or support, please send an email enquiry to [email protected]⁠