diff --git a/README.md b/README.md new file mode 100644 index 0000000..f59c1a5 --- /dev/null +++ b/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 + - body-parser@1.18.3 + - cors@2.8.5 + - dotenv@7.0.0 + - eslint@8.7.0 + - express@4.16.4 + - express-fileupload@1.4.0 + - helmet@3.18.0 + - morgan@1.10.0 + - nodemon@2.0.20 + - pg@8.8.0 + - prettier@2.5.1 + - react-dual-range-slider@1.0.4 + - react-js-multi-range-sliders@0.1.6 + - react-lazyload@3.2.0 + - react-loader-spinner@5.3.4 + +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 + - axios@1.1.3 + - dotenv@7.0.0 + - eslint@8.7.0 + - fetch@1.1.0 + - node-fetch@3.3.0 + - prettier@2.5.1 + - primeicons@6.0.1 + - primereact@9.0.0-beta.1 + - react@17.0.2 + - react-client-session@0.0.8 + - react-dom@17.0.2 + - react-router-dom@5.2.0 + - react-scripts@5.0.1 + - recharts@2.4.0 + - web-vitals@2.1.4 + - sass@1.58.0 + + +## 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. + +