Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Latest commit

 

History

History
445 lines (331 loc) · 8.49 KB

README.md

File metadata and controls

445 lines (331 loc) · 8.49 KB

Location Tracking Backend

This repository contains the backend code for a location tracking system built using Node.js.

Table of Contents

Setup and Run

Prerequisites

  • Node.js (v12.x or higher)
  • npm (v6.x or higher)
  • MongoDB

Installation

  1. Clone the repository: 
    git clone https://github.com/datmaiq/location-tracking-be.git
cd location-tracking-be
  2. Install the dependencies: 
    npm install
  3. Create a .env file in the root directory and add the following environment variables: 
    # Add your environment variables here
JWT_SECRET_KEY="<your secret here>"
MONGO_URL="mongodb+srv://<user>:<password>@<url>/<db-name>"
  4. Run the application: 
    npm run server

Running the Application

The API server will start on http://localhost:8000.

API Documentation

Authentication

Register a new user

  • URL: /api/auth/sign-up
  • Method: POST
  • Body Parameters:
    • username: String
    • password: String

Login

  • URL: /api/auth/sign-in
  • Method: POST
  • Body Parameters:
    • email: String
    • password: String

Authenticate

  • URL: /api/auth/authenticate
  • Method: GET
  • Headers:
    • Authorization: Bearer token

User

Get User Profile

  • URL: /api/users/profile
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Location

Add Location

  • URL: /api/locations
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • latitude: Number
    • longitude: Number
    • timestamp: String

Get Locations

  • URL: /api/locations
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Delete Location

  • URL: /api/locations/:id
  • Method: DELETE
  • Headers:
    • Authorization: Bearer token

Friends

Send Friend Request

  • URL: /api/friends
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • userId: String
    • friendId: String

Get Friends List

  • URL: /api/friends/:userId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Get Potential Friends

  • URL: /api/friends/potential
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Add Friend

  • URL: /api/friends/add
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • id: String

Get Friends CSV Data

  • URL: /api/friends/csv
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Messages

Send Message

  • URL: /api/messages
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • senderId: String
    • receiverId: String
    • message: String
    • timestamp: String

Get Messages

  • URL: /api/messages/:chatId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Delete Message

  • URL: /api/messages/:messageId
  • Method: DELETE
  • Headers:
    • Authorization: Bearer token

Autocomplete

Get Autocomplete Suggestions

  • URL: /api/autocomplete/:query
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Chat

Create New Chat

  • URL: /api/chats
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • senderId: String
    • receiverId: String

Get Chat By User ID

  • URL: /api/chats/:userId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Get Chat Between Two Users

  • URL: /api/chats/:firstUserId/:secondUserId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

ERD (Entity-Relationship Diagram)

Location Tracking Backend

This repository contains the backend code for a location tracking system built using Node.js.

Table of Contents

Setup and Run

Prerequisites

  • Node.js (v12.x or higher)
  • npm (v6.x or higher)
  • MongoDB

Installation

  1. Clone the repository: 
    git clone https://github.com/datmaiq/location-tracking-be.git
cd location-tracking-be
  2. Install the dependencies: 
    npm install
  3. Create a .env file in the root directory and add the following environment variables: 
    # Add your environment variables here
JWT_SECRET_KEY="<your secret here>"
MONGO_URL="mongodb+srv://<user>:<password>@<url>/<db-name>"
  4. Run the application: 
    npm run server

Running the Application

The API server will start on http://localhost:8000.

API Documentation

Authentication

Register a new user

  • URL: /api/auth/sign-up
  • Method: POST
  • Body Parameters:
    • username: String
    • password: String

Login

  • URL: /api/auth/sign-in
  • Method: POST
  • Body Parameters:
    • email: String
    • password: String

Authenticate

  • URL: /api/auth/authenticate
  • Method: GET
  • Headers:
    • Authorization: Bearer token

User

Get User Profile

  • URL: /api/users/profile
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Location

Add Location

  • URL: /api/locations
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • latitude: Number
    • longitude: Number
    • timestamp: String

Get Locations

  • URL: /api/locations
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Delete Location

  • URL: /api/locations/:id
  • Method: DELETE
  • Headers:
    • Authorization: Bearer token

Friends

Send Friend Request

  • URL: /api/friends
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • userId: String
    • friendId: String

Get Friends List

  • URL: /api/friends/:userId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Get Potential Friends

  • URL: /api/friends/potential
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Add Friend

  • URL: /api/friends/add
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • id: String

Get Friends CSV Data

  • URL: /api/friends/csv
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Messages

Send Message

  • URL: /api/messages
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • senderId: String
    • receiverId: String
    • message: String
    • timestamp: String

Get Messages

  • URL: /api/messages/:chatId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Delete Message

  • URL: /api/messages/:messageId
  • Method: DELETE
  • Headers:
    • Authorization: Bearer token

Autocomplete

Get Autocomplete Suggestions

  • URL: /api/autocomplete/:query
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Chat

Create New Chat

  • URL: /api/chats
  • Method: POST
  • Headers:
    • Authorization: Bearer token
  • Body Parameters:
    • senderId: String
    • receiverId: String

Get Chat By User ID

  • URL: /api/chats/:userId
  • Method: GET
  • Headers:
    • Authorization: Bearer token

Get Chat Between Two Users

  • URL: /api/chats/:firstUserId/:secondUserId
  • Method: GET
  • Headers:
    • Authorization: Bearer token