Skip to content

Commit a5b6423

Browse files
authored
Merge pull request #55 from Computer-Science-Club-OCC/add-dev-instructions-to-readme
Add guidelines for developer
2 parents 05cf108 + 024d18c commit a5b6423

File tree

1 file changed

+3
-22
lines changed

1 file changed

+3
-22
lines changed

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,7 @@
1+
# OCC Computer Science Club Website
12
You can view a preview of the site here:
23
https://Computer-Science-Club-OCC.github.io/public
34

4-
# To run locally
5-
6-
Command to install necessary packages:
7-
8-
### `npm install`
9-
10-
Commands to build and run website on http://localhost:3000/
11-
To build:
12-
13-
### `npm run build`
14-
15-
Then run:
16-
17-
### `npm start`
18-
19-
20-
# Format code
21-
Before running server or pushing your commits.
22-
Please run:
23-
### `npm run format:fix`
24-
25-
Fix any red error messages that appear on browser or terminal, then save debugged files. The website will run normally after that.
5+
## Getting Started
6+
Visit and follow instructions from <a href="https://github.com/Computer-Science-Club-OCC/Computer-Science-Club-OCC.github.io/wiki/Guide-for-Developers">Guide for Developers</a>
267

0 commit comments

Comments
 (0)