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.

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

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 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.

Available Scripts

In the project directory, you can run:

`yarn start`

Runs the app in the development mode.
Open 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 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 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.

To learn React, check out the React documentation.

Paperclip Cloudinary

Setup - Backend server

Create a Cloudinary 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_PORT=<port>
REACT_APP_REQUEST_OPTIONS_HTTP_PROTOCOL=<protocol>
REACT_APP_CLOUD_NAME=<cloudName>

Create a .env.production file in the root repository of the project and paste the following:

REACT_APP_REQUEST_OPTIONS_HOST=<host>
REACT_APP_REQUEST_OPTIONS_PORT=<port>
REACT_APP_REQUEST_OPTIONS_HTTP_PROTOCOL=<protocol>
REACT_APP_CLOUD_NAME=<cloudName>

Deployment

This section has moved here: 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 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

Contributions

If you see something wrong or not working, please check the issue tracker section, 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
Twitter: @MaryleneSawyer
Linkedin: Marylene Sawyer

Acknowledgements

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

Bluette1/holiday-homes-website