Carpool platform for students

Official deployment: unicovoit.com

• Features
• Contribute and Support
• Tech Stack
• Environment Variables
• Run Locally
• Deployment
• Authors
• Acknowledgements
• License
• Public API Reference

• All accounts are verified as belonging to a student
• Add and book trips between students
• Mark your trip as recurring so that you don't have to add the same one every week
• Add and book trips up to 3 weeks in advance
• Light/dark mode toggle

UniCovoit doesn't handle payments

If you want to contribute to the project, feel free to open an issue or create a pull request.

If you have any feedback, you can reach me on Discord (finxol#8918), Twitter or via email on contact@finxol.io

You can also support the project by donating to the GitHub Sponsorship Program.

Framework: Vuetify, Nuxt + Typescript

Server: Node (Typescript), Express

To run this project, you will need to add the following environment variables to your .env file

AUTH0_CLIENTID=<your auth0 client ID>
AUTH0_DOMAIN=<your auth0 tenant domain>
MAPBOX_TOKEN=<your mapbox token>

Clone the project

  git clone https://github.com/finxol/unicovoit

Go to the project directory

  cd unicovoit

Install dependencies

  yarn install

Start the server

  yarn dev

Before building, your need a .dockersecrets directory

.dockersecrets
├── auth0_clientid.txt
└── auth0_domain.txt

The files respectively contain the Auth0 Client ID and the Auth0 tenant domain.

To build and run with podman, run:

  yarn podman

If you prefer using Docker, just replace podman with docker in the commands above.

• @finxol

UniCovoit is still under development. Not all features might be implemented yet

• Vuetify frontend framework
• Nuxt.js
• Authentication by Auth0
• Distance and duration calculated by Mapbox
• Illustrations from Icons8
• Font Grammatika from Font Library

For more information, please read the LICENSE file, or go to Choose A License.

  GET /api/v1/trips

  GET /api/v1/trips/distance

Returns a json object containing the distace in kilometers and duration in minutes

{
    "distance": 0,
    "duration": 0
}

All other API routes are only accessible by authenticated users