Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmikaia/ridetogether-client
The front-end side of Ride Together
https://github.com/dmikaia/ridetogether-client
firebase-auth firebase-storage nextjs14 radix-ui shadcn-ui websocket-client
Last synced: 19 days ago
JSON representation
The front-end side of Ride Together
- Host: GitHub
- URL: https://github.com/dmikaia/ridetogether-client
- Owner: DMikaia
- License: mit
- Created: 2024-07-18T06:05:55.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-13T17:42:31.000Z (5 months ago)
- Last Synced: 2024-11-03T07:42:47.569Z (2 months ago)
- Topics: firebase-auth, firebase-storage, nextjs14, radix-ui, shadcn-ui, websocket-client
- Language: TypeScript
- Homepage:
- Size: 732 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ride Together
This is the client part of my team's school project called **Ride Together** (carpooling web application). The purpose of this application is to help people find carpooling offer easily.
## Content
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Environments](#environments)
- [Running the app](#running-the-app)
## Features
Here are the current features right now:
- Basic authentication with Firebase & PostgreSQL
- User (get, update)
- Offer (creation, get, update)
- Room (get)
- Review (crud)
- Live chat using websocket
## Prerequisites
To be able to run the app you'll need to install:
- [nodejs](https://nodejs.org/)
- [npm](https://www.npmjs.com/)
- [firebase project](https://firebase.google.com)
## Installation
```bash
# command
$ npm install
```
## Environments
```bash
# Server url
NEXT_PUBLIC_SERVER_URL=
# Firebase
NEXT_PUBLIC_API_KEY=
NEXT_PUBLIC_AUTH_DOMAIN=
NEXT_PUBLIC_PROJECT_ID=
NEXT_PUBLIC_STORAGE_BUCKET=
NEXT_PUBLIC_MESSAGING_SENDER_ID=
NEXT_PUBLIC_APP_ID=
NEXT_PUBLIC_MEASUREMENT_ID=
```
## Running the app
> [!IMPORTANT]
> You'll also need to configure the firebase project and add authentication (email and password) and storage, otherwise authentication and image storage won't work properly on either the server or client side. If you are not yet familiar with firebase, you may wish to consult the [documentation](https://firebase.google.com/docs)
```bash
# dev
$ npm run dev
# prod
$ npm run start
# build
$ npm run build
```
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.