chore: add getting started for contributers

vim · Sep 10, 2024 · b16a043 · b16a043
1 parent e8dfd8c
commit b16a043
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -23,5 +23,17 @@ The setup for this project consists of three main parts: the website (web), the
 - Docker and Docker Compose
 - Node.js and npm
 - MySQL 8
+- Node version manager like NVM
+- Make
 
 ### Getting Started
+
+```
+git checkout development
+
+nvm use # if you have node version manager installed otherwise ensure you have the correct node version, specified in .nvmrc
+
+make init # installs dependencies and creates .env files
+
+make start-local # starts containers for local development
+```
diff --git a/makefile b/makefile
@@ -80,6 +80,9 @@ clean:
 start:
 	$(DC_DEV) up -d
 
+start-local:
+	$(DC) up -d
+
 stop:
 	$(DC) stop