Device Management Platform - Backend

Welcome to the open source Backend repository. We're excited to have you here and invite you to contribute to the development of this project.

Table of Contents

• Introduction
• Getting Started
  • Prerequisites
  • Configuration
  • Docker Deployment
• API Reference
• Contributing
• Code of Conduct
• License

Introduction

This repository contains the backend code to manage the mobile devices, it's using Google APIs Node.js Client, a powerful solution for to interact with google APIs. The backend is built using Node.js and provides essential functionality and APIs for the platform's operation.

The motivation behind this project to provide the power to the enterprises to deploy on premises management system.

Getting Started

Prerequisites

Before you begin, ensure you have the following prerequisites installed if not using docker:

• Node.js: Download (v16.5.1)
• npm (Node Package Manager): Download (v8.11.0)

Configuration

1. Set up your Google Application Credentials and create the auth.json file on root of this project:

To get the auth.json file please follow the official google guidelines

2. Setup the project configurations

Create a .env file in app folder and define the following parameters
PROJECT_ID="your_google_project_id"
PUBSUB_TOPIC='projects/'$PROJECT_ID'/topics/mdmpubsub'
PROVESION_URL="https://5268-91-72-173-142.ngrok.io/enterprise/callback"
SERVER_PORT=9013
GOOGLE_APPLICATION_CREDENTIALS="auth.json"

3. Sqlite database file is this file.

4. To start the project, run the following command:

 npm start

Docker

You have to do the configurations step 1,2 and 3 on the 4th step you can choose to run this server in docker container or in your machine

I highly recommend OrbiStack to test this project on local

Create Image

  docker build -t mdmasurei .

Run Container

  docker run --name mdmasurec --env-file app/.env -d -p 9012:9013 mdmasurei

API Reference

We have create the api endpoints to intract with google Android management service you can find the complete documentation here.

Note! If you are running this on local machine to test, then you have to expose the service to the public, i will recommend ngrok to make the tunnel, The device provisioning will need to reach the

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.