SPARCS Taxi

KAIST Taxi Party Matching Web Service

About

Taxi는 KAIST 구성원들의 택시 동승 인원 모집을 위한 서비스입니다. 🚖 비교적 거리가 먼 장소에 갈 때 택시 동승이 빈번하게 발생하는 점을 인지하고, 이를 어플/웹 서비스를 통해 보다 편리하게 이루어지도록 하고자 합니다.

Management Information

• Notion : Sparcs Notion Taxi page (Only SPARCS members can access it)
• Slack : #taxi-main, #taxi-notice, #taxi-bug-report, #taxi-github-bot, #taxi-notion-bot (Only SPARCS members can access it)

Prerequisite

• Recommended node version : >=18.0.0 (Node v18.18.0, for example)
• Recommended pnpm version : >=8.0.0 (pmpm v8.8.0, for example)
• Recommended mongoDB version : 5.0.8

Project Setup

Clone Repositories

$ git clone https://github.com/sparcs-kaist/taxi-front
$ git clone https://github.com/sparcs-kaist/taxi-back

Install Requirements

$ pnpm install

Set Environment Configuration

See notion page. Refer to .env.example and write your own .env.

Backend Route Information

API specification is defined on Swagger. Start development server and visit /docs to see the specification of each endpoint. Some endpoints are not documented in Swagger yet. For those endpoints, refer to routes/docs/README.md.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributors

See contributors of frontend and contributors of backend.

Accompanying Project

• frontend : https://github.com/sparcs-kaist/taxi-front
• backend : https://github.com/sparcs-kaist/taxi-back
• app : https://github.com/sparcs-kaist/taxi-app
• docker : https://github.com/sparcs-kaist/taxi-docker
• figma : https://www.figma.com/file/li34hP1oStJAzLNjcG5KjN/SPARCS-Taxi?node-id=0%3A1