Skip to content

Commit 955c21f

Browse files
committed
Updating README with LFS instructions
1 parent 336c5cf commit 955c21f

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ this application, please reach out to [support@mpdx.org](mailto:support@mpdx.org
1111

1212
## Getting Started
1313

14+
### Setting up Node
15+
1416
First, make sure that you have a suitable version of Node.js. This project uses node v20.17.0. To check your node version, run `node --version`. If you don't have node v20.17.0 installed or a suitable version, the recommended way to install it is with [asdf](https://asdf-vm.com/), a development tool version manager.
1517

1618
```bash
@@ -31,6 +33,31 @@ asdf install nodejs
3133
node --version
3234
```
3335

36+
### Download yarn cache with Git LFS
37+
38+
Because we store the yarn cache in the GitHub repo, we use Git LFS to manage these large zip files.
39+
40+
**Install Git LFS (if not installed):**
41+
42+
```bash
43+
brew install git-lfs
44+
```
45+
46+
Alternatively, download from the [official site](https://git-lfs.com/).
47+
48+
**Initialize Git LFS and pull LFS files**
49+
50+
```bash
51+
# If you haven't initialized git-lfs locally before, run:
52+
git lfs install
53+
54+
# Fetch the LFS files (Ensure you're inside the repo's directory):
55+
git lfs pull
56+
57+
```
58+
59+
### Running the local server
60+
3461
Then, make sure you get the environment variables necessary for this project from another developer and put them in a `.env` file in the project's root directory.
3562

3663
Once you have these variables you can install the dependencies.

0 commit comments

Comments
 (0)