Skip to content

Commit 190bf02

Browse files
committed
Added how to use instructions
1 parent 78a00ac commit 190bf02

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,19 @@ sort -u <file> -o <file>
2626

2727
4\. Please don't submit requests that say "make this nationality". We will accept helpful contributions, but not orders :)
2828

29+
### How to use
30+
31+
1. Run `npm install`
32+
33+
2. Make sure you have gulp installed globally (npm i -g gulp) and run `gulp build`
34+
35+
3. Run `gulp` to verify all tests pass
36+
37+
4. Start the server with `npm start`
38+
2939
### What if I want to add a new nationality?
3040
Go ahead! We will gladly accept new regions if they follow the guidelines above.
3141
Just place your files in a new directory in the `api/.nextRelease/data` folder with the appropriate 2 letter ISO Country Code (http://countrycode.org). Follow the format of the US folder for reference.
3242

3343
### How to contact us
34-
If you have any questions, feel free to ask us on our Twitter page [@randomapi](https://twitter.com/randomapi).
44+
If you have any questions, feel free to ask us on our Twitter page [@randomapi](https://twitter.com/randomapi).

0 commit comments

Comments
 (0)