Group project Web Portfolio project
The project is a Property management web app that helps people to rent or buy property at any part of the World. We are using API to list the available houses, With Agents to facilitate the process.
This contains project on API and TDD. It is part of the projects at Alx Full-stack program. It demonstrates the knowledge we have gained so far: React, node and Mongo db
alx_africa
The ALX Holberton Software Engineering programme is a 12-month(70h/week) immersive programme that engages technology enthusiasts and budding software engineers in a variety of programmes across in-demand tech disciplines to prepare them for a global career as a Full-Stack Developer.
Follow the steps highlighted below how to get the application running on your local computer
1. Ensure you have `node` with version >=14 installed. To find out about this, Open a command prompt or terminal and type `node -v`
2. You have cloned the repo from github
3. You have a text editor (preferably vscode) installed on your computer
1. Open the project folder with your desire code editor
2. Open a built in terminal without included with your text editor
3. To install all dependencies used in the project, type in `npm install (dependency-name)` into the open terminal and click enter on your keyboard
4. To ensure the project is open with rules specific by eslint used in this project, type in `npm run lint` on the terminal
5. Next, ensure the project files are rightly formatted by typing in `npm run format`
6. Finally, to start the development server, `npm run start`
At this Point, you should see the application running on a broswer window/tab at [http://localhost:3000]
If you encounter any issues while doing any of the above commands, kindly the sections below on the available scripts to find for little more insight. If the issue persist, kindly contact Mildred => @ [email protected]
In the project directory(housify), you can run:
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
Checks if files obeys all Eslint set rules properly
This script fixes all possible eslint errors in the project
Formats all files using prettier set rules at .prettierrc
Checks if all files are formatted properly
Checks if files obeys the Eslint rules and are formatted properly
/components
Components ├──Home └── Agent ├── Blog ├── About │ │ ├── About.js │ │ └── Credibility.js | | |__ Service.js | | |__ Team.js └── contact ├── footer
components contains pages shown on the website. It should be structured in a similar way as the router to give you a better understanding of how the real website would be browsed. This is also similar to the Next.js approach.
utils ├── useFetch.js └── partners.js
/utils contains files that deal with logic to fulfill a certain function. They are functional pieces commonly used in many places in the project.
Give a ⭐ if project was helpful
Copy © 2022.
Project is MIT licensed
AUTHORS