Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surojcodes/financial_institutions
Simple REST API for financial institution CRUD and more. Made using Nodejs (Express js) and MongoDB (mongoose.js)
https://github.com/surojcodes/financial_institutions
es6-javascript expressjs mongodb mongoose nodejs rest-api
Last synced: about 1 month ago
JSON representation
Simple REST API for financial institution CRUD and more. Made using Nodejs (Express js) and MongoDB (mongoose.js)
- Host: GitHub
- URL: https://github.com/surojcodes/financial_institutions
- Owner: surojcodes
- Created: 2020-06-02T10:41:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T23:17:16.000Z (about 2 years ago)
- Last Synced: 2023-03-05T09:23:54.964Z (almost 2 years ago)
- Topics: es6-javascript, expressjs, mongodb, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage: https://surojmaharjan0.github.io/financial_institutions/
- Size: 726 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Financial Institutions in Nepal
> Simple **REST API** for financial institution CRUD and more.
> Made using **Nodejs (Express js)** and **MongoDB (mongoose.js)**
## Usage
Rename config/config.env.env to config/config.env and update the settings values of your own
## Install Dependencies
```
npm install
```
## Run App
```
# In development mode
npm run dev
#In production mode
npm start
```
## Database Seeder
To seed your database with the data in data folder, run
```
# To import data
node seeder -i
# To delete data
node seeder -d
```
***
## Basic Features
* Category create, update, read and delete
* Add banks by category
* Get all banks in a category
* Bank read, update and delete
* Upload logo for banks
## More Features
* *Custom error handling with asynchronous middleware*
* *Custom validation* in mongoose schema
* Advanced results supported for reading bank information
* can *search using specific field value* in the schema
(fetch all banks with slug nepal-finace-ltd)
```
/api/v1/banks?slug=nepal-finance-ltd
```
* can *select particular fields* in results
(fetch all bank's name and emails field only)
```
/api/v1/banks?select=name,emails
```
* *Search inside array* fields
(fetch all banks whose contact array has number 4565678)
```
/api/v1/banks?contact[in]=4565678
```
* *Sort* the results (default is by creation date/latest first)
(fetch all the bank and sort the records by descending order of name)
```
/api/v1/banks?sort=-name
```
* *Pagination* (default is 5 results per page)
(fetch all banks, limit 3 results per page and show page number 2 )
```
api/v1/banks?limit=3&page=2
```
* *Populate and reverse populate using virtuals*
* *Automatic Slug* genetation using mongoose *pre hook*
* *Regular Expression* for email and url validation
* *Serving Static files* feature for logos
***
## Security Features
* NoSQL injection secure
* Security headers has been added
* Cross-site scripting(XSS) secure
* Rate Limit has been set
* An IP can request upto 100 times within 10 min
* Cross-Origin Resource Sharing (CORS) enabled
* HTTP Param Pollution prevented
***
## Demo
Simple Documentation [here](https://surojmaharjan0.github.io/financial_institutions/)
Extensive Documentation with example [here](https://documenter.getpostman.com/view/7716156/SztG35yR)
* Version **1.0**
* Author **Suroj Maharjan**