Rent The RoadShow (RTRS)

Rent The RoadShow is an online destination where users can explore cars, list their cars for rent, and leave reviews.

Meet the developer behind Book-In-Style~

Rent The Roadshow is brought to you by Cecilia Zhao. Thank you for visiting!

---

Index

Navigating this ReadMe

• Technologies Used
• Getting Started
• Features

Technologies Used

Getting Started

How do I run this project?

1. Clone this repo

   • git clone git@github.com:cc-y-zhao/renttheroadshow.git

2. Install dependencies from the root directory

   • npm install

3. Create a POSTGRESQL user with CREATEDB and PASSWORD in PSQL

   • CREATE USER <name> WITH CREATEDB PASSWORD '<password>'

4. Create a .env file in the backend directory based on the .env.example found within the respective directory

5. Enter your psql user's name and password information into your .env file along with your desired database name, a secured combination of characters for your JWT_SECRET, and your desired PORT (preferably 5000)

6. Add the following proxy to your package.json file within your frontend directory, replacing or keeping the 5000 port to match your PORT configuration found in your .env file.

   • "proxy": "http://localhost:5000"

7. Create Databse, Migrate, and Seed models:

   • npx dotenv sequelize db:create
   • npx dotenv sequelize db:migrate
   • npx dotenv sequelize db:seed:all

8. Start the services in the backend directory

   • npm start

9. Start the services in the frontend directory, which should open the app in your default browser. If not, navigate to http://localhost:3000.

   • npm start

10. You can use the Demo Login or create an account to being using RTRS.

How do I log in as a Demo User?

On the log in page, click "Demo Login".

Features

Listings

Users can create, edit, and delete car listings.

Reviews

Users can create, update, and delete reviews.