Skip to content

Wambeo/Landlord-App

Repository files navigation

LandLord App

Welcome to Renty, a LandLord App

By Samuel Wambeo, Sharon Obinda, Samfelix Orimba

Description

This is our End Of Phase 2 Group Project at Moringa School.

This is where we will build out a React application that displays a list of properties, among other features.

Tools used

  • vs code

  • json server

  • GitHub

  • Google Chrome.

  • Git

  • Tailwind

  • React Toastfy

Setup/Installation requirements

*To use this repo on your machine follow the steps below

  • Open a terminal/command line interface on your computer

  • Clone the repo by using the following:

    git clone:https://github.com/Wambeo/LandLord-App.git

  • Change directory to the repo folder;

    cd LandLord-App

  • To Open the repo in Visual Studio Code: code .

Use the following steps to run the application;

  • First, make sure that you have 'json-server' installed globally or locally in your project.

  • In this project, you will install it locally by navigating to your project directory and run the following command on your vs code terminal;

    npm install json-server

  • Also, ensure that you have Node.js and npm installed and that they are up to date

Then follow the instructions below for live server to work well with json-server​

  • Run the following command to get server started:​npx json-server --watch db.json
  • Test your server by visiting this route in the browser: http://localhost:3000/apartments/
  • In a new terminal, run the following command;npm run dev
  • Copy the local link to your browser, This will run your React app on port 5173.

Core Deliverables

As a user, I should be able to;

  • Fill out and submit the form to add a new apartment. This should add the new apartment to the page as well as post the new apartment to the backend API for persistence.
  • Delete Apartment
  • Update Apartment
  • View Apartment
  • Filter Apartment by typing into the search bar. Only apartments with a description matching the search term should be shown in the featured apartments page.

Known Bugs

The application works perfectly well, no bugs.

Live link

Deployed Frontend can be accessed here Renty App
Deployed Backend can be accessed here Renty App

Authors

  • SHARON OBINDA

  • SAMUEL WAMBEO

  • SAMFELIX ORIMBA

Support and contact details

email:: sharon.obinda@student.moringaschool.com phone:: +254769600939

email:: samuelwambeo9@gmail.com phone:: +254746134774

email:: samfelix.orimba@student.moringaschool.com phone:: +254719451143

License

*Licenced under the MIT License Copyright (c) 2024