Skip to content

Commit 259afd3

Browse files
authored
Merge pull request #1 from dannyhp1/develop
Updated README with instructions.
2 parents 90983f1 + 3776cef commit 259afd3

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
# Coderpad
2-
The mission of the project is to provide an interactive coding editor for developers.
1+
## Coderpad
2+
The mission of the project is to provide an interactive coding editor for developers.
3+
4+
### To start development:
5+
#### 1. Clone the project.
6+
#### 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.
7+
#### 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.
8+
#### 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.

0 commit comments

Comments
 (0)