From 30180f6593ed1a0e9d4aa0ae2ac37b66e2b5ed0b Mon Sep 17 00:00:00 2001 From: Max Morgan Date: Tue, 16 Jul 2024 18:12:01 -0400 Subject: [PATCH] Add development instructions to README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index a987920..fb92acc 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,29 @@ Still in development. See deployment here: https://kwheelan.github.io/budget-request-demo/ + +## Contributing + +This repo uses yarn for package management and webpack for a +development server and production bundler. + +### Setup + +Install Node.js (recommend using [nvm](https://github.com/nvm-sh/nvm)) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install/) if you don't have it already. + +Install package dependencies: +```bash +yarn +``` + +Run the development server: +```bash +yarn start +``` + +### Creating a New Release + +Run webpack bundler: +```bash +yarn build +``` \ No newline at end of file