Broke-Brokers / Broke_BRokers-soen341projectF2023

This is the github for everything about the SOEN341 real estate project of the Broke Brokers team
0 stars 0 forks source link

README

Important notes and Updates


For sprint 3 : (https://github.com/Broke-Brokers/Broke_BRokers-soen341projectF2023/wiki/Sprint-3)


2023-10-17

For sprint 2 : https://github.com/Broke-Brokers/Broke_BRokers-soen341projectF2023/wiki/Sprint-%232


2023-09-29

We learned that our repository was not correctly set up on 2023-09-28

It also came to our attention from the prof's updates on the sprint #2 planning presented in class yesterday that we did not introduce the backlog and sprints backlog in the correct manner. We did not know we could use the "project" and "issue" tab to do this.

We will transfer all the information from external files and internal .md files and wiki to the project tab and create issues from the tasks for sprint #2.

For sprint #1 the files can be found here:


1. PROJECT DESCRIPTION

This project uses Agile Scrum principles and consists of creating a real estate web application to serve homebuyers, property renters, brokers, and administrators. The project duration is 12 weeks and comprises 4 incremental sprints. The web application allows users to search for properties, save favourites, request property visits, and perform CRUD operations (Create, read, update, delete) on property listings. Brokers can submit offers, manage property listings, match properties with buyers, and oversee visits. See information on project approach and choice of Agile method here

2. TEAM MEMBERS AND ROLES

3. TEAM BACKGROUND

4. APPROACH AND TECHNOLOGY

See project approach and tehcnology section in the Wiki!

6. Installation instructions

When the project is completed, the user will click on the given link to be led to our website in order to create an account. After that, the user will be able to use the website's functionality such as search for proprieties and request visits.

Getting Started with Create React App

This project was bootstrapped with Create React App.

install additional components

react cookies

react range selector :

npm install react-range

emailJs

npm install @emailjs/browser --save

Pop up

npm i reactjs-popup

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.\ Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.\ You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.\ See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.\ It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

7. Usage Guidelines

7.1. Introduction and Purpose:

These usage guidelines govern your use of the Broke Broker website and anything accessible there. By using the website, you acknowledge that you have read, understood, and agree to the following terms and that you have the power to bind yourself and anyone you represent. Please don't use the website if you disagree with these terms.

7.2. User Responsibilities:

You confirm that you meet the legal requirements for entering contracts and are not prohibited by law from accessing our services. If you are a minor below the legal age of majority in your province, you can only use our services under parental supervision. If you are a parent allowing a minor to use our services, you are responsible for ensuring the minor agrees to these terms, monitoring their use, and supervising their online behaviour.

7.3. Prohibited Activities:

The inclusion of links or linkages to the Broke Broker website on the websites of people or organizations that publish violent, pornographic, or otherwise gravely offensive material is explicitly forbidden. Additionally, it is expressly prohibited for anybody or any organization involved in the real estate world to publish links on their websites that lead people to the Broke Brokers' website and engage in direct or indirect competition with Broke Brokers. We reserve the right to delete, without prior notice, any suspicious publications.

7.4. Content Guidelines:

Through our services, you can save real estate searches, bookmark properties, subscribe to alerts, access real estate resources, and utilize other features that we may introduce from time to time. Additionally, we may provide information about our partners, subsidiaries, affiliated companies, sponsors, and other content that we believe you may find interesting. When new services, content, or features are added to our services, their use will be subject to these terms.

7.5. Dates to Guidelines:

The guidelines may be updated periodically, and users should regularly review them. Any changes made to these guidelines will be effective the next time this website is being used.

7.6. Privacy policy:

You Are Notified of The Collection Of Your Information By This Privacy Notice