proximity-server

This is proximity services

Usage no npm install needed!

<script type="module">
  import proximityServer from 'https://cdn.skypack.dev/proximity-server';
</script>

README

Proximity Server

  • Sm = the m-th server device in a proximity domain size of M+1 server devices

Sensor Modes

  • Wifidirects hardware
  • Wifi hardware
  • Geolocation hardware

Functions

  • Offline dynamic data interactions and contents
  • Proximity based Virtual Private Network for offline dynamic transactions
  • Proximity based location mapping of entities
  • Proximity based distributed computing on the client-side
  • Proximity based business solutions such as proximity-commerce, proximity-social, etc
  • Proximity based financial solutions
  • Proximity based distributed machine learning
  • Proximity based robotics, artificial intelligence, and machine learning algorithms

Applications

  • Proximity commerce solutions
  • Proximity social solutions
  • Proximity IoTs
  • Proximity games
  • Service Infracstructure management
  • Offline proximity financial solutions
  • Proximity land-mapping for surveyors
  • Proximity on-premise customer relationship management solutions
  • Interior position machine learning solutions
  • Mobile traffic solutions and analytics
  • Proximity business intelligence

Research papers

  • Proximity Mathematical Analysis
  • Proximity Economics and Success Factor Analysis
  • Proximity Finance and Success Factor Analysis
  • Quantum Computing and Proximity
  • Proximity, Machine Learning, and Data Science

Installation

git clone https://www.quantumics.net/proximity-server.git proximity-server
cd proximity-server && npm install
npm install --save proximity-server

Getting Started

To startup the server and use out of the box, change directory to proximity-server folder and type in the terminal as shown below:
cd $PATH_TO_PROXIMITY_SERVER_FOLDER
npm start

Import
Else, to use the server API in a module, import and construct a proximity server as shown in the code below.
const ProximityServer = require('proximity-server')
const proximityServer = new ProximityServer(key, secret)
Register
Goto developer registration link to register and get a KEY and SECRET for your app. Then use
proximityServer.register(username, email, password)
to register a server user to grant access to the local and cloud proximity database.
Login
proximityServer.login(username, password)
Then server users can login with the command shown above to login to local and cloud proximity servers and start developing your applications.
Initialize
Ones the server is constructed and you've logged in successfully, you must always intialize the server before it is started as shown below
proximityServer.initialize()
Start
Ones the initialization process is done, you can start your proximity server with the command shown below
proximityServer.start()
Stop
Stopping the server is as easy as starting, just use the command below to stop the server
proximityServer.stop()
Logout
Sometimes, you may want to switch user control, use the command below to logout. Then, use the login command with the new user credentials
proximityServer.logout()


Local Queries
You may prefer to user REST API syntax to interface with the local server. In anycase this is for you, follow the syntax below to make queries to the local server ones started.
curl -X POST $PROXIMITY_LOCAL_REST_URI/[username]/[userId]/[deviceId]/[endpoints]
Cloud Queries
Use the syntax below to make query to the proximity cloud server
curl -X POST $PROXIMITY_CLOUD_REST_URI/[username]/[userId]/[deviceId]/[endpoints]
Endpoints
The list of REST endpoints available on both local and cloud proximity servers are:
  • /query
  • /first_proximity
  • /search