From 89824ebb8b647181c3c45ced9fd9c13356c3fd2c Mon Sep 17 00:00:00 2001 From: Danny Pham Date: Thu, 28 Nov 2019 13:42:18 -0800 Subject: [PATCH 1/2] Updated README. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3694f69..01f2d86 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ # Coderpad -The mission of the project is to provide an interactive coding editor for developers. \ No newline at end of file +The mission of the project is to provide an interactive coding editor for developers. + +### To start development: +#### 1. Clone the project. +#### 2. Enter the project directory and make sure the coderpad-client has been pulled as well. Run `git submodule init` and `git submodule update` subsequently. +#### 3. To run the client, go into the coderpad-client project root and run `npm install` and then `npm start`. The frontend will be deployed to `localhost:3000` by default. +#### 4. To run the server, go into the executor project root and run `python3 executor_server.py`. The backend will be deployed to `localhost:5000` by default. \ No newline at end of file From 3776cef5b01bf7317bc030790a6960ff9e618bdf Mon Sep 17 00:00:00 2001 From: Danny Pham Date: Thu, 28 Nov 2019 13:44:14 -0800 Subject: [PATCH 2/2] Modified README to display instructions. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01f2d86..4dfc057 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Coderpad +## Coderpad The mission of the project is to provide an interactive coding editor for developers. ### To start development: