- Node.js 12.19.0 or newer
- The latest version of NPM or Yarn, compatible with Node 12.19.0 or newer
- Expo-CLI 3.22.1 or newer
- An active Discourse site
- If you don’t have one, please follow the instructions in Development Setup
Clone the repository and navigate into it:
git clone [email protected]:lexiconhq/lexicon.git cd lexicon
Next, install the project's dependencies and generate its GraphQL schema:
$ npm install && npm run generate
npm run generate involves two steps.
First, it will generate a GraphQL schema in the
Then, using the generated schema, it will create a new folder called
frontenddirectory, containing the resulting query and mutation types.
This allows the frontend codebase to stay in sync with, and not duplicate the code for, the types from the
This is a necessary process from our tooling, Apollo.
Launch the Mobile App
You can run the app and test it out by running this command from the project root:
$ npm run quickstart
This will simultaneously launch two processes:
- The Prose GraphQL API Server
- The local Expo dev server, which will enable you to launch the React Native app from your device
Please note that this takes some configuration to setup properly.
quickstartcommand configures the Mobile App and the Prose GraphQL API to point at https://meta.discourse.org, as an example.
You'll need to make adjustments to point at a site of your choice.
The Lexicon Mobile App (via Expo) must be configured to point at the Prose GraphQL Server
The Prose GraphQL Server must be configured to point at an active Discourse instance
More details are available in the Development Setup section