Appointio (front-end)
Browse apartments and schedule a tour before you rent. Built with React/Redux and Rails back-end.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
- About the Project
- Getting Started
- Usage
- Run Tests
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
Note
The user login/register feature is not working due to browser cross-site cookie blocking. This will be fixed in about a month when the next update is released.
About The Project
This is a Single-Page tablet web app built with React/Redux (front-end) and Rails (back-end). The topic of this app is to book an appointment to schedule a tour of an apartment before you rent. You will have a list of apartments based on type to browse through. You can visit the apartment details page to know more and book an appointment.
Built With
- React
- Redux
- ESLint
- Stylelint
- SASS
- Styled components
- npm
- Rails REST API
- React-image-gallery
- Prop-types
- Netlify
Live demo
IMPORTANT! You have to enable third-party cookies in your browser otherwise you won't be able to login.
Deployed to Netlify - live demo.
Getting Started
You need the back-end server for this app to work. You can find the intructions to setup back-end server locally here.
To get a local copy up and running follow these simple steps.
Prerequisites
-
npm
npm install npm@latest -g
Installation
-
Clone the repo
git clone https://github.com/tirthajyoti-ghosh/final-capstone-frontend.git
-
Install NPM packages
npm install
-
Start local server
REACT_APP_BASE_URL=http://localhost:3001 npm start
Please note that only
npm start
won't work as this app relies on this environment variable. -
Visit
http://localhost:3000/
in your browser.
Run Tests
IMPORTANT! You need the back-end server for the tests to work. You can find the intructions to setup back-end server locally here.
Run this command in your terminal:
REACT_APP_BASE_URL=http://localhost:3001 npm test
Please note that only npm test
won't work as this app relies on this environment variable.
Roadmap
- Implement JWT authentication instead of relying on Rails sessions.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
👤 Tirthajyoti Ghosh
- Website: tirthajyoti
- GitHub - @tirthajyoti-ghosh
- Twitter - @terrific_ghosh
- LinkedIn - linkedin
Project Link: https://github.com/tirthajyoti-ghosh/final-capstone-frontend
Acknowledgements
- Site design - https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign
- README Icon made from Icons8
- Img Shields