Hostfully products give property managers the tools they need to automate operations, reach more customers, and deliver a 5-star guest experience.

---

       

Table of Contents

• Getting started
• Responsive design
• File structure
• Contributors

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Please check SETUP.MD file to get to know requirements and instructions.

Responsive design

This project works perfectly for both web and mobile uses. The layout is automatically defined according to the available screen width (minimum of 1110px for web viewing).

File structure

Root files

Configuration contents such as dotfiles, plugins, scripts and some utils must be accessible from the project root.

├──📁 src
├──👾 .eslintrc
├──👾 package.json

Source files

Our main divisions, separated by responsibilities within the project. May contain global files, like testUtils.tsx, that are used by different project resources.

├──📁 components
├──📁 pages
├──👾 testUtils.tsx

Resources files

Each resource must contain a unique structure that brings together everything necessary for its correct functioning.

├──📁 components
│  ├──📁 Button
│  │  ├──📁 __tests__
│  │  │  └──👾 Button.test.tsx
│  │  ├──👾 Button.styles.ts
│  │  ├──👾 Button.tsx
│  │  └──👾 index.ts
├──📁 pages

Shared files

Some files may share common content. To avoid repetitions in both uses, we declare the file globally within the parent directory.

├──📁 components
│  ├──📁 modals
│  │  ├──👾 success.ts
│  │  └──👾 failure.ts
│  ├──📁 AwesomeCustomModal
│  ├──📁 AnotherRandomModal

Contributors

Samuel Pietra