Expedition
The Expedition monorepo.
Contributing
Contributions welcome! Earn loot points while practicing your coding skills on the bleeding edge of web. If you're new to any of our tools or libraries, don't worry - we're happy to help and answer questions!
Not sure what to work on? Check out our open issues, especially those labeled with help wanted.
Repository structure
All shared code goes in /shared, all deployed code goes in /services. Code in services can only reference shared code, and should not reference other services.
Development
Setup
Install Node 8.11.3 using NVM
Install global dependencies: npm install -g yarn cordova webpack@4 webpack-cli@3 webpack-dev-server@3
Install local dependencies: yarn run setup
Run the tests to make sure everything's working: yarn test
TEMPORARY SETUP NOTES
While we continue to consolidate the monorepo, you'll also need to run npm install -g karma-cli
Running the code
You can run anything in /services by running the yarn command of the same name, for example the app by running yarn run app.
For the services that depend on the API server, you can also run them against a local copy of the API server by running it as X-local, for example yarn run app-local.
Tests and linting
yarn test runs all tests in the repo; you can also run tests for a specific service as X-test, for example yarn run app-test.
Linting is run automatically to verify each commit; tests are run automatically to verify each push.
Linting errors? yarn run lint --fix fixes most common linting issues automatically. For alphabetization issues, in Sublime Text you can select multiple lines of text then hit F5 to auto-sort them.
Questions?
Reach us at contact@expeditiongame.com