Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rakibul58/steeraway-server
https://github.com/rakibul58/steeraway-server
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rakibul58/steeraway-server
- Owner: rakibul58
- Created: 2024-06-11T15:22:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-30T15:44:36.000Z (4 months ago)
- Last Synced: 2025-01-05T00:48:09.692Z (3 days ago)
- Language: TypeScript
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# SteerAway
## Car Rental Reservation System
[Live URL](https://steer-away.vercel.app/)
### Table of Contents
- [Project Overview](#project-overview)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Usage Guide](#usage-guide)
- [Usage](#usage)
- [Credentials](#Credentials)
- [Contact](#contact)
## Project Overview
SteerAway is a comprehensive car rental reservation system backend with features for booking and managing car rentals. Users can easily search for available cars, make booking, and admin can manage bookings and returns.
## Features
- **User Authentication:** Secure sign-up and login functionality.
- **Car Search and Filter:** Admin can filter bookings based on carId and date.
- **Booking Management:** Users can view the cars, book it if available.
- **Admin:** Manage cars, bookings.
## Technologies Used
- **Backend:** Typescript, Node.js, Express
- **ODM:** Mongoose
- **Database:** MongoDB
- **Deployment:** Vercel
## Usage Guide
Follow the following instructions to run the application locally.
### Step 1
Open command prompt(`cmd`) in folder where you want to add the project.
### Step 2
Run the following command to clone the repository:
```
git clone https://github.com/rakibul58/steerAway-batch-3-assignment-3.git
```
### Step 3
Open the cloned folder or run the following in cmd:
```
cd steerAway-batch-3-assignment-3
```
### Step 4
In the cloned folder run the following command on cmd:
```
npm install
```
### Step 5
On the root directory add a `.env` file and add your database url and other environment variables bellow:
```
NODE_ENV=development
PORT=5000
DATABASE_URL=
BCRYPT_SALT_ROUNDS=
JWT_ACCESS_SECRET=
JWT_ACCESS_EXPIRES_IN=
DEFAULT_PASSWORD=
```
### Step 6
Run the following code to start the development server:
```
npm run start
```
Other commands can be found in package.json scripts
## Usage
Once the application is set up and running, you can access it at http://localhost:5000 (or the appropriate port if specified differently). From there, you can create an account, log in, and start booking cars.
## Credentials
### Admin Credentials
- **Email:** [email protected]
- **Password:** admin123
### User Credentials
- **Email:** [email protected]
- **Password:** user123
## Contact
For any questions or feedback, please contact:
- **Name:** Muhammed Rakibul Hasan
- **Email:** [email protected]