Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tirthajyoti-ghosh/appointio
Browse apartments and schedule a tour before you rent. Built with React/Redux and Rails back-end.
https://github.com/tirthajyoti-ghosh/appointio
apartment-finder appointment-booking netlify react-redux react-router reactjs
Last synced: about 1 month ago
JSON representation
Browse apartments and schedule a tour before you rent. Built with React/Redux and Rails back-end.
- Host: GitHub
- URL: https://github.com/tirthajyoti-ghosh/appointio
- Owner: tirthajyoti-ghosh
- Created: 2020-10-04T17:00:17.000Z (about 4 years ago)
- Default Branch: development
- Last Pushed: 2023-03-06T15:30:32.000Z (almost 2 years ago)
- Last Synced: 2024-04-23T23:06:55.967Z (8 months ago)
- Topics: apartment-finder, appointment-booking, netlify, react-redux, react-router, reactjs
- Language: JavaScript
- Homepage: https://ghosh-appointio.netlify.app/
- Size: 2.39 MB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License: MIT][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
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](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Run Tests](#run-tests)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#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](https://adoring-pike-d04b95.netlify.app/)
## 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](https://adoring-pike-d04b95.netlify.app/).
## 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](https://github.com/tirthajyoti-ghosh/final-capstone-backend).
To get a local copy up and running follow these simple steps.
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/tirthajyoti-ghosh/final-capstone-frontend.git
```
2. Install NPM packages
```sh
npm install
```
3. Start local server
```sh
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.
4. 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](https://github.com/tirthajyoti-ghosh/final-capstone-backend).
Run this command in your terminal:
```sh
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**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
👤 **Tirthajyoti Ghosh**
- Website: [tirthajyoti](https://tirthajyoti-ghosh.github.io/Portfolio/)
- GitHub - [@tirthajyoti-ghosh](https://github.com/tirthajyoti-ghosh)
- Twitter - [@terrific_ghosh](https://twitter.com/terrific_ghosh)
- LinkedIn - [linkedin](https://www.linkedin.com/in/tirthajyoti-ghosh/)
Project Link: [https://github.com/tirthajyoti-ghosh/final-capstone-frontend](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](https://shields.io)
[contributors-shield]: https://img.shields.io/github/contributors/tirthajyoti-ghosh/final-capstone-frontend.svg?style=flat-square
[contributors-url]: https://github.com/tirthajyoti-ghosh/final-capstone-frontend/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/tirthajyoti-ghosh/final-capstone-frontend.svg?style=flat-square
[forks-url]: https://github.com/tirthajyoti-ghosh/final-capstone-frontend/network/members
[stars-shield]: https://img.shields.io/github/stars/tirthajyoti-ghosh/final-capstone-frontend.svg?style=flat-square
[stars-url]: https://github.com/tirthajyoti-ghosh/final-capstone-frontend/stargazers
[issues-shield]: https://img.shields.io/github/issues/tirthajyoti-ghosh/final-capstone-frontend.svg?style=flat-square
[issues-url]: https://github.com/tirthajyoti-ghosh/final-capstone-frontend/issues
[license-shield]: https://img.shields.io/badge/License-MIT-yellow.svg
[license-url]: https://github.com/tirthajyoti-ghosh/final-capstone-frontend/blob/development/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/tirthajyoti-ghosh/