mirror of https://github.com/status-im/metro.git
Summary: <!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory. --> Currently index.js points to snapshot-testing which doesn't exist. Perhaps the intent was to link to the API page so that is what I changed. <!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? --> front page 'learn more' link should work <!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. --> Closes https://github.com/facebook/metro/pull/107 Reviewed By: cpojer Differential Revision: D6511913 Pulled By: pelmers fbshipit-source-id: 2a68a817cf4a318fb7dbfd5ea9a10fbea9e72620 |
||
---|---|---|
.. | ||
blog | ||
core | ||
i18n | ||
pages/en | ||
static | ||
README.md | ||
languages.js | ||
package.json | ||
publish-gh-pages.js | ||
sidebars.json | ||
siteConfig.js |
README.md
You will need Node 6 or newer in order to build the Metro website.
Run the server
The first time, get all the dependencies loaded via
yarn
in the root directory.
Then, run the server via
npm start
Open http://localhost:3000
Anytime you change the contents, just refresh the page and it's going to be updated
Publish the website
The Metro website is hosted as a GitHub page. A static site is generated by
server/generate.js
and its output is pushed to the gh-pages
branch by
CircleCI whenever master
is updated.
To deploy the website manually, run the following command as a Git user with write permissions:
DEPLOY_USER=facebook GIT_USER=metro-bot CIRCLE_PROJECT_USERNAME=facebook CIRCLE_PROJECT_REPONAME=metro npm run gh-pages
Staging
Run the above command against your own fork of facebook/metro
:
DEPLOY_USER=YOUR_GITHUB_USERNAME GIT_USER=YOUR_GITHUB_USERNAME CIRCLE_PROJECT_USERNAME=YOUR_GITHUB_USERNAME CIRCLE_PROJECT_REPONAME=metro npm run gh-pages