From 34e0e465c11b2c9b8d7d03f6a96667c1e2b89e8f Mon Sep 17 00:00:00 2001
From: ianarawjo <fatso784@gmail.com>
Date: Thu, 4 May 2023 20:46:48 -0400
Subject: [PATCH] Add Contributor Guide

---
 CONTRIBUTOR_GUIDE.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 CONTRIBUTOR_GUIDE.md

diff --git a/CONTRIBUTOR_GUIDE.md b/CONTRIBUTOR_GUIDE.md
new file mode 100644
index 0000000..910078f
--- /dev/null
+++ b/CONTRIBUTOR_GUIDE.md
@@ -0,0 +1,37 @@
+# Contributor Guide
+
+This is a guide to running the current version of ChainForge, for people who want to develop or extend it. 
+Note that this document will change in the future.
+
+## Getting Started
+### Install requirements
+Before you can run ChainForge, you need to install dependencies. `cd` into `python-backend` and run
+
+```bash
+pip install -r requirements.txt
+```
+
+to install requirements. Ideally, you will run this in a `virtualenv`.
+
+To install Node requirements, `cd` into `chain-forge` and run:
+
+```bash
+npm install
+```
+
+### Running ChainForge
+To serve ChainForge, you currently have to spin up at least two servers:
+one for React front-end, one for the Flask backend.
+
+`cd` into `chain-forge` directory and run:
+
+```
+npm run start
+```
+
+to serve the React front-end. Then in a separate terminal `cd` into `python-backend` and run:
+
+```bash
+python app.py --port 8000 
+```
+You can add the `--dummy-responses` flag in case you're worried about making calls to OpenAI.