Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 2.55 KB

README.md

File metadata and controls

74 lines (59 loc) · 2.55 KB

Karpo

logo

Introduction

Karpo is a mobile app developed as a term project for the "Cloud Native Application Development" course at National Taiwan University in Autumn 2023. The purpose of Karpo is to provide a carpooling platform, connecting users who share similar routes to optimize transportation efficiency and minimizing environmental impact. The app is built with a React Native frontend and a Python backend, providing a seamless and responsive user experience.

Features

  • User Authentication: Secure user accounts with authentication and authorization mechanisms.
  • Carpool Creation: Users can create carpools, specifying details such as pick-up and drop-off locations, time, and date.
  • Carpool Matching: Intelligent algorithm matches users with similar routes, facilitating efficient carpooling.
  • Real-time Updates: Users receive real-time updates on their carpools, including notifications and in-app messaging.
  • Rating and Reviews: Rate and review fellow carpoolers to build a trustworthy community.
  • Responsive Design: Mobile-friendly UI for a smooth experience on various devices.

Prerequisites

Before you begin, ensure you have the following prerequisites:

  • Node.js and npm
  • Python
  • Docker

Installation

Clone the repository:

git clone https://github.com/kaienlin/karpo.git
cd karpo

Frontend

  1. Navigate to the frontend directory
    cd frontend
  2. Install dependencies:
    yarn
  3. Start the development server
    yarn start

For more details, refer to the Frontend README.

Backend

  1. Navigate to the backend directory:
    cd backend
  2. Build the docker image:
    make build-dev
  3. Start the containers
    make docker-up

For more details, refer to the Backend README.

Acknowledgments