README.md

RentalApp 💻

🏡 Creating a Rental App to reduce the burden that comes with finding a rental or tenant. 🏘️

Introduction 🔍

🚗 Welcome to Vroom 🚗

During the next 12 weeks the Vroom Development ream will be creating a house rental application. We will be documenting the experience so that others learn from our experiences.

Before you run/start the app

Before everything else, try running the command npm i first inorder to get all the required packages before you run the app.

Front End Instructions 📚

The front end of our application is React. You can start the webapp by changing the directory to rental-app-frontend and running the command below.

npm start

Back End Instructions 📖

The back end of our application is Express and MongoDB. We decided on using typescript as the language of choice instead of javascript. However, typescript will transpile this into javascript for us. This file will be generated in the "dist" inside the express-rental-backend directory. Change directories to express-rental-backend and run the command below.

npm run dev

Source Code Design Instructions

We have implemented both the Prettier and ESLint to our app. You can use them by typing in any of the command below.

npm run prettier        // Formats the Source Code
npm run prettier-check  // Checks if the Source Code is formattable or not
npm run eslint-fix      // Finds and Fixes Javascript problems automatically
npm run eslint          // Just Finds the problems and let you know where it is from

Additional Information 📚

Scripts can be found in package.json. 📕 Typescript configurations can be found in tsconfig.ts 📗

Feel free to play with codes, if you have a crazy idea, then please create a pull request :)