Skip to content

Updated README with instructions. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 28, 2019
Merged

Updated README with instructions. #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89824eb
Updated README.
dannyhp1 Nov 28, 2019
3776cef
Modified README to display instructions.
dannyhp1 Nov 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# Coderpad
The mission of the project is to provide an interactive coding editor for developers.
## Coderpad
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.