Home - Rent-Cap/website GitHub Wiki
RentCap MVP
Welcome to RentCap! This project is an effort to help Californians figure out whether the Tenant Protection Act of 2019 will protect them from excessive rent increases.
Most renters will be affected, but our goal is to help them answer that question using publically available data based on their address.
Check out our website!
Text of the Bill and more about it
Project Materials
Basic Planning
- Product Brief for RentCap
- Design files (I believe Kyle has them)
- Original Wireframes with Flow Diagram
- User Flow Description
- Consumer Price Index charts: CitiesTable1, CitiesTable2, SanFrancisco
- Carmen Tang's website for reference
- Carmen's Calculator
- An English-Spanish Translation doc
- TechEquity's article on Medium website about helping get bill passed
- Flowchart Questions
- Kyle's Calculator Wireframe
Tech Stack
RentCap is built in React and statically hosted on Netlify.
| Front End | Back End | Deployment |
|---|---|---|
| React | None | Netlify |
| Gatsby |
Features
Getting Started
Some general stuff to put on this page
What are the programming languages, from frontend to backend?
How can necessary languages and frameworks be installed?
Which services are used for hosting, monitoring, DNS, etc?
What’s the suggested text editor and operating system for new devs?
How does a new developer clone the repo onto their computer?
What are the different environments (test, staging, production, etc)?
Are there syntax preferences for the project’s chosen language (if so, include a style guide)?
What people will use Rent-Cap for
For answering the following questions:
- Am I eligible for rent control?
- How much will my rent be / go up? (calculate their rent and/or rent increase)
- Will I get a "rollback", and how much is it?
- What are my tenant rights?
They can also:
- read information or be directed to other useful resources
- access a version of the rent-cap website in either English, Spanish, or Chinese
Installation:
Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.
How to install locally:
First download
Usage:
The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action