add readme

README.md

@@ -0,0 +1,113 @@
+## Rent Proof
+  Rent Proof is a web application that helps tenants keep track of their rental payments and provides a platform for landlords to manage their rental properties.
+
+
+## Screenshots
+
+### Main Page
+
+!["Screenshot of Main page"](docs/main.png)
+
+### Add/Edit Property
+
+!["Screenshot for adding property"](docs/book.png)
+
+### Graph
+
+!["Screenshot for graph"](docs/delete.png)
+
+
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+## Getting Started
+  To get started with Rent Proof, you'll need to install both the client and server dependencies. Here's how:
+
+Clone the Rent Proof repository from GitHub:
+  git clone https://github.com//jamesraymondbrown/rent-tracker
+
+Install the server dependencies:
+  cd rent-proof/server
+  npm install
+
+Install the client dependencies:
+  cd ../client
+  npm install
+
+Start the server:
+  cd ../server
+  npm run start
+
+Start the client:
+  cd ../client
+  npm run start
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
+## Server Scripts
+  start: Starts the server
+  reset: Resets the database to its initial state (run this only in development mode)
+  dev: Starts the server in development mode using nodemon
+
+
+## Dependencies
+
+Server:
+
+ - @googlemaps/markerclusterer@2.0.15
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+
+Client:
+
+ - @fortawesome/fontawesome-svg-core@6.3.0
+ - @fortawesome/free-solid-svg-icons@6.3.0
+ - @fortawesome/react-fontawesome@0.2.0
+ - @google/markerclustererplus@5.1.3
+ - @googlemaps/markerclusterer@2.0.15
+ - @react-google-maps/api@2.7.0
+ - @testing-library/jest-dom@5.16.5
+ - @testing-library/react@12.1.5
+ - @testing-library/user-event@13.5.0
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+
+
+## Scripts
+ - start: Starts the client
+ - build: Builds the client for production
+ - test: Runs the client's test suite
+ - eject: Ejects the client from react-scripts
+
+## Proxy
+  The client is configured to proxy API requests to the server at http://localhost:8001.
+
+