-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
296d5d4
commit 69112ff
Showing
6 changed files
with
398 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
NODE_ENV=development | ||
PORT=5001 | ||
MONGODB_URL='mongodb://localhost/psgc' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,43 @@ | ||
# PSGC (Philippine Standard Geographic Code) | ||
API used for listing all the region, province, city, municipality, and barangay. All data came from <a href='https://psa.gov.ph' target='_blank'>Philippine Statistics Authority</a>. This API includes the total population for each regions etc. and other information. | ||
|
||
# ENDPOINTS | ||
```https://psgc-api.herokuapp.com```<br/> | ||
# ENDPOINTS (v1.1) | ||
All Region - ```/api/region```<br/> | ||
Specific Region - ```/api/region/:code```<br/> | ||
List of Province in specific Region - ```/api/region/:code/province```<br/><br/> | ||
All Province - ```/api/province```<br/> | ||
Specific Province - ```/api/province/:code```<br/> | ||
List of City in specific Province - ```/api/province/:code/city```<br/> | ||
List of Municipality in specific Province - ```/api/province/:code/municipality```<br/> | ||
All City - ```/api/city```<br/> | ||
Specific City - ```/api/city/:code```<br/> | ||
List of Barangay in specific City - ```/api/city/:code/barangay```<br/> | ||
All Municipality - ```/api/municipality```<br/> | ||
Specific Municipality - ```/api/municipality/:code```<br/> | ||
List of Barangay in specific Municipality - ```/api/municipality/:code/barangay```<br/> | ||
All Barangay - ```/api/barangay```<br/> | ||
Specific Barangay - ```/api/barangay/:code```<br/> | ||
|
||
# ENDPOINTS (V1) | ||
REGION - ```/v1/region```<br/> | ||
PROVINCE - ```/v1/province```<br/> | ||
CITY - ```/v1/city```<br/> | ||
MUNICIPALITY - ```/v1/municipality```<br/> | ||
BARANGAY - ```/v1/barangay```<br/> | ||
|
||
# SETUP | ||
```$ npm install``` | ||
|
||
# START DEV SERVER | ||
```$ npm run dev``` | ||
|
||
# PLANS | ||
- [ ] fix the python script to merge all json according to appropriate codes | ||
- [ ] automate uploading of json file once there's a new PSGC Excel File | ||
- [ ] fix all the endpoints | ||
- [x] fix all the endpoints | ||
- [x] add rate limit | ||
- [ ] create the frontend with docs | ||
- [ ] move to a proper server | ||
- [ ] add rate limit | ||
|
||
Made with 💜 by Justin Balaguer | ||
<a href='twitter.com/ojintoji/'>Twitter</a> | ||
<a href='facebook.com/ojintojix/'>Facebook</a> | ||
<a href='facebook.com/ojintojix/'>Facebook</a> | ||
###### dm me on any social media above to get the json files |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.