API Hosted On

• shelter-api.cyclic.app (Primary)

Frontend Hosted On

• shelter-three.vercel.app/ (Live Preview)
• github.com/prince-appiah/shelter (Source Code)

📔 Table of Contents

• 📔 Table of Contents
  • 🌟 About the Project
    • 👾 Tech Stack
    • 🎯 Features
  • 🧰 Getting Started
    • ‼️ Prerequisites
    • 🔑 Environment Variables
    • 🏃 Run Locally
  • 🧭 Roadmap
  • 👋 Contributing
    • 📜 Code of Conduct
  • ⚠️ License
  • 🤝 Contact

🌟 About the Project

Shelter is a full stack property management app that connects room hunters to rooms/spaces/apartments around them.

PLEASE NOTE: This project is still under development, hence minor features are being developed.

👾 Tech Stack

Client

• Typescript
• React.js
• Redux Toolkit
• Redux Persist
• Chakra UI
• Axios
• Formik
• Yup

Server

• Express.js
• CORS
• Helmet
• Mongoose ORM
• Node Mailer
• JSON Webtoken
• Sentry
• Cloudinary

Database

• MongoDB

DevOps

• Cyclic

🎯 Features

• Users are able to book and cancel property
• Admin can upload property on behalf of hosts
• Admin can approve or disable properties posted by hosts
• Admin can view all bookings
• Hosts are able to upload their properties on the platform

🧰 Getting Started

You may test the live application with the following credentials:

Admin: [email protected]

Customer: [email protected]

PLEASE NOTE: OTP codes are sent to your emails after signup and login. In the case where you use any of the emails provided above, kindly check your browser console/network tab for the otp in the server response. PS: OTP codes will NOT be sent (for security reasons), when the app is fully ready for all users (actual production environment)

‼️ Prerequisites

This project uses Yarn as package manager

 npm install --global yarn

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

REACT_APP_BACKEND_URL

NODE_ENV

CLOUDINARY_CLOUD_NAME

CLOUDINARY_PRESET

🏃 Run Locally

Clone the project

  git clone https://github.com/prince-appiah/shelter.git

Go to the project directory

  cd shelter

Install dependencies

  yarn

Start the server

  yarn start

🧭 Roadmap

• Authentication (Sign/Log in, Logout)
• Admin - create listings
• Host - view dashboard information
• Host - view dashboard information
• Verify hosts accounts with identity verification
• Allow customers to rate properties
• Display properties based on user's location

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

• Gmail
• Dribbble
• Github

💖Like my work?

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️.