Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mubangizi/triangle-checker
A node app that returns the triangle type depending on the input
https://github.com/mubangizi/triangle-checker
expressjs nodejs
Last synced: 29 days ago
JSON representation
A node app that returns the triangle type depending on the input
- Host: GitHub
- URL: https://github.com/mubangizi/triangle-checker
- Owner: Mubangizi
- License: mit
- Created: 2020-04-18T11:19:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:12:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T09:24:32.242Z (3 months ago)
- Topics: expressjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 402 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CircleCI](https://circleci.com/gh/Mubangizi/triangle-checker/tree/master.svg?style=svg)](https://github.com/Mubangizi/triangle-checker/tree/master)
# Triangle Checker
A node app that returns the triangle type depending on the input
### Table of API routes
| URL | HTTP Method | Description |
| ----------- | -------------------- | ------------------- |
| /triangle | POST | Returns type of triangle |## How to setup the project:
#### Clone the repository
` git clone https://github.com/Mubangizi/triangle-checker.git`* If `master` is not up to date, `git checkout develop` for it is the default base branch for this project.
#### Install a package manager
Install `npm`
* Navigate to this page and get instructions on how to download `npm` for your OS. [click here.](https://www.npmjs.com/get-npm)
* Navigate to the project root directory and to install dependencies by running
> `npm install`* Run `npm start` to start the application.
* Run `npm test` to run tests for the Application.
* When running application, go to a browser input `/api-docs` to access the api documentation