Skip to content

Commit 4476c12

Browse files
committedMar 7, 2022
Added README
1 parent 5307304 commit 4476c12

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed
 

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# FOSS Weekend Participants API
2+
3+
## About
4+
This is an API with data on all participants of IIIT-L Equinox's FOSS Weekend (that's you!) with 2 endpoints currently, one which returns data on all the participants and another which returns data on the participant with the requested roll number. All data is in JSON format. 2 endpoints sounds too little? Don't worry, you can add more (look at the Issues tab 👀)
5+
6+
Tackling issue #1 is MANDATORY for all participants. Don't miss it!
7+
8+
## Local Setup
9+
- After forking and cloning this repository to your local machine, open the project folder in your favourite code editor.
10+
- In the terminal, ensuring you are in the project folder, run `npm i` to install all the dependencies
11+
- To start the development server, run `npm run devStart`. You should see some output ending with `listening at http://localhost:3000/ in development` Go to this link to see the server in action. In case you need to stop the server (though you probably won't need to), just press `ctrl + C`
12+
- After making any changes to the code, refresh the browser to see how it affects the results.
13+
14+
Pro tip: To run any other commands in the terminal (like git commands), you don't need to stop the development server, just open another instance of the terminal (in VS Code, press the little plus sign to the top right of the terminal)

0 commit comments

Comments
 (0)
Please sign in to comment.