AirBnB Clone

Welcome to the AirBnB clone project!

Table of Contents

• Description-of-the-project
• Installation
• Phase-One
• Description-of-the-command-interpreter
• Usage
• Examples
• Project-Structure
• Packages
• Contributors
• License

Description of the project

The AirBnB clone project starts now until… the end of the first year. The goal of the project is to deploy on your server a simple copy of the Airbnb Website.

You won’t implement all the features, but be implemented in phases. After 4 months, you will have a complete web application composed by:

• A command interpreter to manipulate data without a visual interface, like in a Shell (perfect for development and debugging)
• A website (the front-end) that shows the final product to everybody: static and dynamic
• A database or files that store data (data = objects)
• An API that provides a communication interface between the front-end and your data (retrieve, create, delete, update them)

Installation

To Use the AIrBnB clone, clone the repository to your local machine and run the console.py file:

git clone https://github.com/FourtyThree43/AirBnB_clone.git
cd AirBnB_clone
./console.py

Phase One

First step: Write a command interpreter to manage your AirBnB objects.

Description of the command interpreter

What’s a command interpreter? Do you remember the Shell? It’s exactly the same but limited to a specific use-case. In our case, we want to be able to manage the objects of our project:

• Create a new object (ex: a new User or a new Place)
• Retrieve an object from a file, a database etc…
• Do operations on objects (count, compute stats, etc…)
• Update attributes of an object
• Destroy an object

Usage

Your shell should work like this in interactive mode:

$ ./console.py
(hbnb) help

Documented commands (type help <topic>):
========================================
EOF  help  quit

(hbnb) 
(hbnb) 
(hbnb) quit
$

But also in non-interactive mode: (like the Shell project in C)

$ echo "help" | ./console.py
(hbnb)

Documented commands (type help <topic>):
========================================
EOF  help  quit
(hbnb) 
$
$ cat test_help
help
$
$ cat test_help | ./console.py
(hbnb)

Documented commands (type help <topic>):
========================================
EOF  help  quit
(hbnb) 
$

Project Structure

.
├── AUTHORS
├── console.py
├── hbnb.png
├── LICENSE
├── models
│  ├── __init__.py
│  ├── amenity.py
│  ├── base_model.py
│  ├── city.py
│  ├── engine
│  │  ├── __init__.py
│  │  └── file_storage.py
│  ├── place.py
│  ├── review.py
│  ├── state.py
│  └── user.py
├── myScripts
│  ├── genAuthors-1.sh
│  ├── genAuthors-2.rb
│  ├── generate-authors.sh
│  ├── pyDoc-script.sh
│  └── pyTest-script.sh
├── README.md
└── tests
   ├── __init__.py
   └── test_models
      ├── __init__.py
      ├── engine
      │  ├── __init__.py
      │  └── test_file_storage.py
      ├── test_amenity.py
      ├── test_base_model.py
      ├── test_city.py
      ├── test_place.py
      ├── test_review.py
      ├── test_state.py
      └── test_user.py

Contributors

This project was written by FourtyThree43 and joyce-source. See the AUTHORS file for more information.

License

The project is licensed under the MIT license. See the LICENSE file for more information.