Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluette1/holiday-homes-website
A holiday homes website application built using React and Redux.
https://github.com/bluette1/holiday-homes-website
ajax cloudinary-api css3 javascript react redux
Last synced: 19 days ago
JSON representation
A holiday homes website application built using React and Redux.
- Host: GitHub
- URL: https://github.com/bluette1/holiday-homes-website
- Owner: Bluette1
- Created: 2021-01-20T23:16:32.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-10T11:35:22.000Z (about 1 year ago)
- Last Synced: 2024-10-22T07:47:49.044Z (2 months ago)
- Topics: ajax, cloudinary-api, css3, javascript, react, redux
- Language: JavaScript
- Homepage: https://holiday-homes-website.fly.dev/
- Size: 4.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# holiday-homes-website
A website application for viewing a list of available holiday homes
This project is a capstone project at the end of the Microverse curriculum. The project's specifications are listed [here](https://www.notion.so/Final-Capstone-Project-Find-Your-House-9a424802e7dc48eb8ef40e2ac09397d1#f6146dd819194da486ce5d60e69b3a93).
## Project description
A simple holiday homes website application built using React and Redux.
## Screenshot
## Built with
- Javascript
- Javascript design patterns
- Node.js
- React.js
- Redux
## Live Demo link
[Holiday Homes Website on heroku](https://holiday-homes-website.fly.dev/)
## Getting Started
To get a local copy up and running follow these simple example steps.
## Prerequisites
- Install node.
## Set up
- Clone the project.
- Cd into the project directory.
- Run ```yarn install``` or ```npm install``` to install dependencies in package.json.
- Run ```yarn start``` or ```npm start``` and view the page on your localhost.
- Clone and run the [backend server](https://github.com/Bluette1/holiday-homes) locally.
## Features
- The user can access the functions of a simple holiday homes display application:
- Display a list of available holiday homes
- Can view details about a selected holiday home in the details page
- Can add and remove favourite holiday homes
- Display a list of the logged in user's favourites
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn 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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn 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](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](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](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](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](https://facebook.github.io/create-react-app/docs/
advanced-configuration)
### [Paperclip Cloudinary](https://github.com/GoGoCarl/paperclip-cloudinary)
#### Setup - Backend server
- Create a [Cloudinary](https://cloudinary.com/) account.
- Afterwards
``Download your configuration YAML file and place it in your config directory. You can grab it here:
https://cloudinary.com/console/cloudinary.yml
This will enable the Cloudinary gem to pick up your configuration automatically.```
#### Setup - Frontend
- Create a `.env.development` file in the root repository of the project and paste the following:
```REACT_APP_REQUEST_OPTIONS_HOST=
REACT_APP_REQUEST_OPTIONS_PORT=
REACT_APP_REQUEST_OPTIONS_HTTP_PROTOCOL=
REACT_APP_CLOUD_NAME=
```
- Create a `.env.production` file in the root repository of the project and paste the following:
```
REACT_APP_REQUEST_OPTIONS_HOST=
REACT_APP_REQUEST_OPTIONS_PORT=
REACT_APP_REQUEST_OPTIONS_HTTP_PROTOCOL=
REACT_APP_CLOUD_NAME=
```
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
- On Heroku, `cloudinary` can be configured using the Heroku cloudinary addon after installing it by running:
```
heroku addons:create cloudinary
```
See [Heroku addon for image management ](https://cloudinary.com/blog/heroku_add_on_for_image_management_in_the_cloud) for further information.
### `yarn build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
## Contributions
If you see something wrong or not working, please check [the issue tracker section](https://github.com/bluette1/holiday-homes-website/issues), if the problem you encountered is not already in the opened issues, then open a new issue by clicking on the `new issue` button.
## Author
👤 **Marylene Sawyer**
- Github: [@Bluette1](https://github.com/Bluette1)
- Twitter: [@MaryleneSawyer](https://twitter.com/MaryleneSawyer)
- Linkedin: [Marylene Sawyer](https://www.linkedin.com/in/marylene-sawyer)
## Acknowledgements
- [Design idea](https://www.behance.net/gallery/37706679/Circle-(Landing-page-Dashboard-Mobile-App)) by [Alexey Savitskiy on Behance](https://www.behance.net/alexey_savitskiy).
- [Microverse](https://www.microverse.org/)
- [Freepik](https://www.freepik.com)
- [Unsplash images](https://unsplash.com/)
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.