diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..1c43a2c --- /dev/null +++ b/.tool-versions @@ -0,0 +1,2 @@ +nodejs 10.16.2 +yarn 1.22.4 diff --git a/README.md b/README.md index 7ea0f6e..669dcc1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,15 @@ all PR are welcome! Note that the database included here is not the same as live, but intended for use in local development. -## Set up locally +## Running the dev server 1. `yarn install && cd client && yarn install` 2. Start backend: `node index.js` 3. start frontend (Optional, front-end is also served through node): `cd client && yarn start` +**Note:** If you are having trouble installing, make sure to use Node version 10. +You can assure this by installing the [ASDF version manager](https://asdf-vm.com/) +and running `asdf install` before repeating the steps above. + +## Fetching data from Untappd The site uses the untappd-api to fetch beer info during the fetch/update routine, which runs nightly. If you wish to use this, go to `server/api.js` and change `clientID` and `clientSecret` with your own API key. If not the site will work normally, but will got be able to run the nightly update routine. diff --git a/client/yarn.lock b/client/yarn.lock index 0169c95..52a0fdb 100644 --- a/client/yarn.lock +++ b/client/yarn.lock @@ -5384,6 +5384,11 @@ lodash.uniq@^4.5.0: version "4.5.0" resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773" +lodash@4.17.13: + version "4.17.13" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.13.tgz#0bdc3a6adc873d2f4e0c4bac285df91b64fc7b93" + integrity sha512-vm3/XWXfWtRua0FkUyEHBZy8kCPjErNBT9fJx8Zvs+U6zjqPbTUOpkaoum3O5uiA8sm+yNMHXfYkTUHFoMxFNA== + "lodash@>=3.5 <5", lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.4, lodash@^4.17.5: version "4.17.11" resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.11.tgz#b39ea6229ef607ecd89e2c8df12536891cac9b8d"