Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 3.76 KB

README.md

File metadata and controls

153 lines (104 loc) · 3.76 KB

Nebeng 🏍️

Nebeng is a ride-sharing app designed specifically for students, providing an efficient and cost-effective way for them to share rides. Whether you have a car or a motorbike with extra space, Nebeng allows you to offer seats to fellow students heading the same way, fostering a community where students can help each other out, save money, and reach their destinations conveniently.

Table of Contents 📑

  1. Introduction

  2. Key Features

  3. Getting Started

  4. API Endpoints

Tim Debest🤝

  1. Hacker
    • Name: Bima Saputra
    • University: Sriwijaya State Polytechnic
  2. Hipster
    • Name: Esya Aulia Rahmadanti
    • University: Sriwijaya State Polytechnic
  3. Hustler
    • Name: Dhea Pujiwanda Fahmi
    • University: Sriwijaya State Polytechnic

Screenshots 🌈

Login & Register

Login & Register

Passenger

Passenger

Driver

Driver

Technologies Used 🛠️

  • Frontend:

    • React Native Expo 📱
    • NativeBase for UI framework 🎨

  • Backend:

    • Express.js 🚀
    • Firebase Firestore 🔥
    • Firebase Authentication 🔑

Key Features 🌟

  • Passenger-Driven Rides:
    • Students can find drivers heading in the same direction, making it a mutually beneficial arrangement.
    • Passengers save money, and drivers earn extra income while helping their peers.

Getting Started 🚀

Frontend

  1. Clone the Project:

    git clone https://github.com/bmsptra24/nebeng.git

  2. Install Dependencies:

    cd ./nebeng/frontend
npm install

  3. Start the Expo Project:

    npx expo start

  4. Running on Emulator/Device:

    • Scan the QR code using the Expo Go app on your mobile device or press 'a' for Android emulator or 'i' for iOS simulator in the terminal.

Backend

  1. Clone the Project:

    cd ./nebeng/backend
npm install

  2. Configure Firebase Credentials:

    • Copy the contents of env.template and configure the environment variables in your backend project.

  3. Configure Base URL:

    • Update the baseUrl in the config.ts file.

  4. Start the Backend Server:

    npm start

  5. Forward port address backend to public in vscode Forward Port

API Endpoints 📡

  • Login:

    • Endpoint: /login
    • Method: POST
    • Request Body: 
      {
  "email": "driver@gmail.com",
  "password": "driver123"
}

  • Nearby-Locations:

    • Endpoint: /nearby-locations
    • Method: GET
    • Request params: 
      lat: 37.7749
lng: -122.4194
radius: 5000
type: restaurant

  • Detail-Location:

    • Endpoint: /getDetailLocation
    • Method: GET
    • Request params: 
      lat: 37.7749
lon: -122.4194