https://github.com/imshubhamsingh/loopback-api

Developing a REST API with Loopback
https://github.com/imshubhamsingh/loopback-api

api loopback node nodejs strongloop

Last synced: about 2 months ago
JSON representation

Developing a REST API with Loopback

• Host: GitHub
• URL: https://github.com/imshubhamsingh/loopback-api
• Owner: imshubhamsingh
• Created: 2018-09-25T03:25:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-29T06:59:38.000Z (over 7 years ago)
• Last Synced: 2025-06-12T15:52:01.928Z (about 1 year ago)
• Topics: api, loopback, node, nodejs, strongloop
• Language: JavaScript
• Homepage:
• Size: 206 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# A complete REST API with Loopback

Before running and testing API, run `npm install` to install all node modules, and `npm run gen:DB` to generate new db file after clearing data in persistance db.

## API Documentation

![API Explorer](https://raw.githubusercontent.com/imshubhamsingh/loopback-api/master/screenshots/api-end-points.png)

## Development server

Run `npm run dev:server` for a 💻 dev server. Navigate to `http://localhost:3000/explore` for 📖 API documentation. The API will automatically reload if you change any of the source files.

To enable mail sending function, add mialGun domain name and api key to `dev` environment in `server/env/.env.dev`

```

  apiKey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

  domain=sandboxXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.mailgun.org

  adminEmail=test@example.com

```

###### Note: The mail sending function will work only in `dev` and `prod` environment

## Tesing

### Unit Tests

Run `npm run test:server` for a 💻 test server, then for unit test run below commands:

- `npm run test:unit` to run unit test

- `npm run test:coverage` to run test coverage