TESTful API (Working-In-Progress)

RESTful API for testing Internet of Things (IoT) devices and prototypes. It is also an API platform that allows you to build IoT prototypes. It is built with Node.js, Express.js and MongoDB.

Table of contents

• Getting Started
  • Installation
• API Documentations
• Create Your Own MongoDB
  • Build a New Cluster
  • Getting SRV Connection String
• Deployment
• To-Dos
• Built With
• Version
• Authors
• License
• Acknowledgments

Getting Started

(Back to top)

Node.js must be installed on local machine in order to run the app. If your local machine does not have Node.js installed, you can download and install from the officical website.

Installation

If you want to run the latest code from git, here's how to get started:

1. Clone the code:

    git clone https://github.com/theinhtut/TESTful-API.git
    cd TESTful-API
   

2. Install testful-api dependencies

    npm install
   

3. Run

    npm start
   

   or

    node server.js
   

Once the server has started, you will see the following in your console.

[email protected] start <YOUR_PATH>\testful-api
node server.js

Server has started on port: 3000
MongoDb is connected...

API Documentations

(Back to top)

API documentations of all the endpoints are powered by Swagger. You can go to http://localhost:3000/docs to view the full documentations.

Create Your Own MongoDB

(Back to top)

If you need to have your own MongoDB' cluster, you must sign up your MongoDB account first.

Build a New Cluster

"Build a new cluster" in MongoDB.

Getting SRV Connection String

1. Click on "Connect" --> "Connect Your Application"
   

2. Copy your Short SRV connection String
   

3. Open the key.js file under the folder config/keys.js
   Then, replace your SRV key in MongoURI: 'YOUR MONGODB SRV CONNECTION STRING'

Deployment

(Back to top)

Currently working in progres to deploy this on a live system.

To-Dos

(Back to top)

Currently Working in Progress

• API Documentations
• Live Server Deployment
• Dashboard
• Better UI/UX
• Integrate NodeRED

Built With

(Back to top)

• Node.js - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
• Express.js - A web application framework for Node.js
• MongoDB - A cross-platform document-oriented database program, JSON-like documents with schemata
• Swagger - API Documentation editor

Version

(Back to top)

TESTful-API v1.0.0

Authors

(Back to top)

• Thein Htut - TESTful-API - Github

See also the list of contributors who participated in this project.

License

(Back to top)

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

(Back to top)

• Brillianda Sheravina - For inspiration by love ❤
• Academind - Awesome YouTube tutorials on RESTful API
• To anyone whose codes were used as reference.