📗 Table of Contents

• 📖 About the Project
  • Built With
    • Tech Stack
    • Key Features
    • Website Mockup 📱 💻 🖥️
  • Rails Backend
  • Kanban Board
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Pinecone Place

Pinecone Place is a luxury room booking application where the user can register new accounts, log in, and reserve appointments for booking rooms. It is built and connected by using two different apps both in different repos. One repo takes care of the back-end side of the application built with Ruby on Rails and PostgreSQL. The second repo takes care of the front-end which was built with JavaScript React-Redux.

Kanban Board 🖧

• Kanban Board

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails API

Database

• PostgreSQL

Key Features

• [Rooms Display page]
• [Room reservation service]
• [Login and Registration using API endpoint]

(back to top)

Rails Backend

• Here is the Backend part of the project room-appointment-backend

(back to top)

🚀 Live Demo

• Live Demo 🚀 😃

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need: Git and Node.js installed on your computer.

• For windows users you can download Git from here: https://git-scm.com/download/win and Node.js from here: https://nodejs.org/en/download/
• For Mac users you can download Git from here: https://git-scm.com/download/mac and Node.js from here: https://nodejs.org/en/download/
• For Linux users you can download Git from here: https://git-scm.com/download/linux and Node.js from here: https://nodejs.org/en/download/

Install

Install this project with:

  npm install # to install all the dependencies

Usage

To run the project, execute the following command:

   npm start # for running the project in development mode
   npm run build # for building the project for production

Run tests

  npm test  # for running the tests

(back to top)

👥 Authors (5 Micronauts)

👤 Jorge

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Abdullateef Bello

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Petro Loltolo Lesapiti

• GitHub: @petrolesapiti
• LinkedIn: @petrolesapiti

👤 Fuad Nabiyev

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Htetaungkyaw

• GitHub: @githubhandle
• Linkedin: @linkedinhandle
• Twitter: @twitterhandle

(back to top)

🔭 Future Features

• [Admin Panel and access to add new rooms]
• [Make a 3D display of each room on Details Page that can be rotated]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

We would like to thank:

• Microverse
• Code Reviewers

Under the the Creative Commons liscense

Original design from Murat Korkmaz on Behance

(back to top)

❓ FAQ

• How I can install vite?

  • You can install vite by running npm install -g vite in your terminal.

• How I can run this project?

  • After cloning repository, run npm install to install all dependencies. Then run npm start to run the project.

• How I can run tests?

  • After cloning repository, run npm install to install all dependencies. Then run npm test to run the tests.

(back to top)

📝 License

This project is MIT licensed.

(back to top)