Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 2.55 KB

README.md

File metadata and controls

88 lines (57 loc) · 2.55 KB
Raw

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)

Prerequisites

  • Recommended npm version : 8.5.5 (with node v.16.15.0)
  • Recommended mognoDB version : 5.0.8
  • Issue with node version

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.

Development

Run scoped scripts

pnpm <scope> <script>

Valid scopes are:

  • web: Corresponds to @taxi/web
  • app: (intended) Corresponds to @taxi/app
  • core: (intended) Corresponds to @taxi/core

Examples

Run web development server

pnpm web start

Install new dependency to app

pnpm app install <package_name>

Testing

This project contains E2E tests with Cypress. To run the test, start React development server with npm start and run test script by npm run test on another shell.

Currently, test only supports local environment

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