vbatts/quay
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add missing setup steps to README

Browse source
This commit is contained in:
Will Gordon 2018-08-26 15:17:09 -04:00
parent f209c7e8ea
commit c0e0cf0934
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -118,7 +118,7 @@ pip install -r requirements-dev.txt
pip install -r requirements-test.txt pip install -r requirements-test.txt
# Setup a local config # 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 ln -s ../../quay-config/local conf/stack
# Install Node Dependencies # Install Node Dependencies
@ -126,6 +126,10 @@ yarn install
# Link Typescript # Link Typescript
yarn link typescript yarn link typescript
# Download external libraries
mkdir static/fonts static/ldn
python external_libraries.py
``` ```
#### Third Party Docs #### Third Party Docs
@ -236,10 +240,10 @@ pyenv uninstall quay-deps
### Adding a Yarn Dependency ### Adding a Yarn Dependency
We use [Yarn](https://yarnpkg.com/) for frontend dependency management. The `yarn.lock` file ensures 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`. 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)). from [here](https://github.com/yarnpkg/yarn/issues/1776#issuecomment-269539948)).
```sh ```sh