RentX

Rent X provides a localized platform for users to buy, rent, or sell items, offering affordable options during financial hardships, convenience for newcomers in a city, a comprehensive commerce solution, and an eco-friendly approach to reduce e-waste, while also catering to trend-conscious consumers.

Table of Contents

• RentX - Backend Setup
  • Libraries Used
  • Prerequisites
  • Getting Started
  • References of technologies used
• RentX - UI Setup
  • Prerequisites
  • Getting Started
  • Commands
  • References of technologies used
  • Opinionated Dev Environment
  • Credits
• Features
• Developers
• License

Overview

This repository contains two folder, ui and server which stores respective code.

---

RentX - Backend Setup

Libraries Used

List the libraries and their versions used in the project.

• Spring Boot: v3.1.4
• Spring Framework: v3.1.4
• Spring Cloud GCP: v4.1.1
• Spring Cloud: v2022.0.1
• Spring Boot Starter Data JPA: v3.1.4
• java-jwt: v4.4.0
• Spring Boot Starter Web: v3.1.4
• Spring Boot DevTools: v3.1.4
• MySQL Connector/J: v8.0.33
• Spring Boot Starter Test: v3.1.4
• Lombok: v1.18.20.0
• Spring Security Core: v6.1.4
• MapStruct: v1.5.5.Final
• Spring Security Config: v6.0.3
• Spring Security Web: v6.0.3
• Jakarta Validation API: v3.0.2
• Spring Security OAuth2 Client: v6.1.4
• Spring Boot Starter Mail: v3.1.4
• Apache Velocity: v1.7
• Mockito Core: v5.6.0
• JUnit: v4.13.2
• TestNG: v7.8.0
• Spring Cloud GCP Starter Storage: v4.1.1

Prerequisites

• Java v19.0.2
• JDK v17
• Maven v3.9.5

Getting Started

Follow these steps to set up and run the project locally.

1. Clone the Repository

 git clone git@git.cs.dal.ca:courses/2023-fall/csci-5308/Group08.git 
 OR
 git clone https://git.cs.dal.ca/courses/2023-fall/csci-5308/Group08.git

2. Navigate to the project directory

cd Group08/server

3. Build the project

mvn clean install
mvn package

4. Run the application

mvn spring-boot:run

5. Deploy the application

The application will be accessible at http://localhost:8080.

References of technologies used:

• Spring Boot
• Spring Framework
• Spring Cloud GCP
• Spring Cloud
• Spring Boot Data JPA
• Java JWT
• Spring Boot Web
• Spring Boot DevTools
• MySQL Connector/J
• Spring Boot Testing
• Project Lombok
• Spring Security Core
• MapStruct
• Spring Security Config
• Spring Security Web
• Jakarta Validation
• Spring Security OAuth
• Spring Boot Mail
• Apache Velocity
• Mockito
• JUnit
• TestNG
• Spring Cloud GCP Storage

RentX - UI

Prerequisites

• NodeJS v20.x

you can use nvm to manage node versions

• pnpm v8.x

check if exists

node --version
pnpm --version

Getting Started

Follow these steps to set up and run the project locally.

1. Clone the Repository

 git clone git@git.cs.dal.ca:courses/2023-fall/csci-5308/Group08.git 
 OR
 git clone https://git.cs.dal.ca/courses/2023-fall/csci-5308/Group08.git

2. Navigate to the project directory

cd Group08/ui

Commands

title	command	description
development	pnpm dev	starts development server
build	pnpm build	generates bundle files in build directory
preview build	pnpm preview	preview of generated bundle by build command
lint	pnpm lint	find the code formatting errors and enforce consistent code style
fix lint	pnpm fix:lint	automatically fix most lint errors
test	pnpm test	run unit tests
watch test	pnpm test:watch	run unit tests in watch mode

Reference of technologies used

• React
• React Router
• Typescript
• Vite
• Tailwind
• LessCSS
• Antd

Opinionated Dev Environment

• Use Visual Studio Code - v1.82.2.
• Install extensions
  • ESLint
  • Prettier - Code formatter
  • Tailwind CSS IntelliSense
• create file at .vscode/settings.json from root of this repository and add the below snippet

{
    "eslint.format.enable": true,
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true 
    },
    "eslint.workingDirectories": [
        {
            "directory": "./ui",
            "changeProcessCWd": true
        }
    ]
}

This will automatically fix lint errors and apply code format defined in eslint and prettier on save file event.

Credits

• Illustrations - https://undraw.co/illustrations

Features

Developers

• Mayursinh Sarvaiya (B00918007) may343777@dal.ca
• Balaji Sukumaran (B00948977) bl664064@dal.ca
• Hiteshkumar Gupta (B00954481) ht643276@dal.ca 
• Tejas Pabbu (B00961226) tj970639@dal.ca 
• Shubham Dippakkumar Jethva (B00965783)  sh526033@dal.ca 

License

This project is licensed under the MIT License - see the LICENSE.md file for details.