Skip to content

fac27/rent-shield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This App was created as part of our final project in collaborationg with Judy from Tech for Better. Rent Shield is a two sided app where landlords and renters can log in and either search or upload a property. The form was designed by the product owner to ensure landlords would upload recent and accurate data.

Contributing

Dependencies

After cloning the repository, install all dependencies with npm install. You can view the project in development in your local server by running:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

🍋 Tech Stack 🍉
Typescript
Supabase
Tailwind + flowbite
Next.js (13)
Cypress
Jest

Deployment

Rent Shied is deployed on Vercel. The Main branch is continuously deployed and can be visited on this link.

All Pull Requests must meet the following requirements before being merged into the main branch:

  • Two collaborating developers have reviewed and approved the request
  • The full test suite has been run and passed (this is done automatically when committing any code)
  • The pull request includes running and passing tests for any new functionalities in the code (every developer is responsible for testing their code)

Planning

Development of Rent Shield is tracked using github projects. This project board is updated regularly and informs the roadmap for new features and code base improvements.

We kept to our sprint planning relatively tight and kept to our user stories. In summary: We Over estimated complexity by 13.79% and under estimated time by 11.33% with a total of 29 points worth of tickets.

MVP

The development of Rent Shield is currently in early stages and is guided towards fullfiling the following user stories: Screenshot 2023-07-26 at 16 46 40

Handover

Details for the project and product process can be found here There is also a .env example file with the variables The dev team have created unresolved issues under the label 'handover'