Merge pull request #3225 from wgordon17/add-missing-setup-steps

Add missing setup steps to README
This commit is contained in:
Joseph Schorr 2018-08-29 16:13:57 -04:00 committed by GitHub
commit 4854f123da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -118,7 +118,7 @@ pip install -r requirements-dev.txt
pip install -r requirements-test.txt
# Setup a local config
git clone git@github.com:coreos-inc/quay-config.git ../quay-config
git clone git@github.com:quay/quay-config-local.git ../quay-config
ln -s ../../quay-config/local conf/stack
# Install Node Dependencies
@ -126,6 +126,10 @@ yarn install
# Link Typescript
yarn link typescript
# Download external libraries
mkdir static/fonts static/ldn
python external_libraries.py
```
#### Third Party Docs
@ -236,10 +240,10 @@ pyenv uninstall quay-deps
### Adding a Yarn Dependency
We use [Yarn](https://yarnpkg.com/) for frontend dependency management. The `yarn.lock` file ensures
that we get consistant version installs using the `yarn install` command. However, new dependencies
that we get consistant version installs using the `yarn install` command. However, new dependencies
should be added using `yarn add <npm package>`. This will add an entry to `package.json` and `yarn.lock`.
Occassionally there will be merge conflicts with `yarn.lock`. To resolve them, use the following (taken
Occassionally there will be merge conflicts with `yarn.lock`. To resolve them, use the following (taken
from [here](https://github.com/yarnpkg/yarn/issues/1776#issuecomment-269539948)).
```sh