feliciahsieh/airbnb_clone

HAirBnB Clone

Welcome

HAirBnB is a subset of the the popular AirBnB app, where people can rent out their lodgings similar to a hotel for a price. A place is listed on the website with information about the place (such as the number of rooms, guests, price, location), amenities, and reviews of the listing. Information about the User (renter and lister) is also collected.

Phase I is the creation of the Command-Line tool, "console", using Python's "cmd" module. This tool can Create, Retrieve, Update, and Delete (CRUD) table data in a few formats (see below). The command tool takes advantages of the Python "cmd" module. All of the table data is saved to a JSON file initially. A database will be incorporated in a future development phase. The Console should be able to be run in interactive mode and non-interactive mode.

The code uses object-oriented programming, the core object is the "BaseModel" object. The other objects derived from BaseModel include User, Place, Review, Amenity, City, and State.

Our project is written entirely in Python and uses the Python "cmd" module.

Table of Contents

• Requirements
• Installation
• Usage
• Example Instructions
• Testing
• Credits
• License

Requirements

• Ubuntu 14.04 LTS
• python3 (v3.4.3)
• PEP 8 styling (v1.7)

Installation

The prompt is "~/AirBnB_clone$". And so, in your terminal, git clone the directory with the following command:

~/AirBnB_clone$ git clone https://github.com/feliciahsieh/AirBnB_clone.git

To run the Command-line tool, "console", type

~/AirBnB_clone$ ./console

If you are a developer who would like to fork our current project to create your own domain-specific HAirBnB, please contact us. See the AUTHORS file.

Usage

It is recommended that the console be run interactively. Although there is a non-interactive version. See below.

~/AirBnB_clone$ ./console

This is how you can use the Console interactively.

You can "echo" the command-line options and pipe the commands into the Console tool as shown below.

Example Instructions

The commands that you can use with our HAirBnB project

Category	Instruction	Description
Console	help [cmd]	Displays help text to user
	quit	Quits Console
	EOF or	Quits Console
General	all [CLASS]	Display class dictionary
BaseModel	create BaseModel	Creates BaseModel instance with a unique ID, saves it to JSON, and prints ID
	show BaseModel [ID]	Displays the specific BaseModel instance
	destroy BaseModel [ID]	Deletes the specific BaseModel instance
	update BaseModel [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given
User	create User	Creates User instance with a unique ID, saves it to JSON, and prints ID
	show User [ID]	Displays the specific User instance
	destroy User [ID]	Deletes the specific User instance
	update User [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given
Place	create Place	Creates Place instance with a unique ID, saves it to JSON, and prints ID
	show Places [ID]	Displays the specific Places instance
	destroy Place [ID]	Deletes the specific BaseModel instance
	update Place [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given
Amenity	create Amenity	Creates Amenity instance
	show Amenity [ID]	Displays the specific Amenity instance
	destroy Amenity [ID]	Deletes the specific Amenity instance
	update Amenity [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given
City	create City	Creates City instance with a unique ID, saves it to JSON, and prints ID
	show City [ID]	Displays the specific City instance
	destroy City [ID]	Deletes the specific City instance
	update City [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given
State	create State	Creates States with a unique ID, saves it to JSON, and prints ID
	show State [ID]	Displays the specific State instance
	destroy State [ID]	Deletes the specific State instance
	update State [ID] [ATTRIBUTE] [VALUE]	Updates the specific instance with data given

[CLASS] include classes used in the app such as "BaseModel", "User", "Place", "Amenity", "City", "State".

[ID] is of the format, "1234-1234-1234"

[ATTRIBUTE] has the following set attributes, but can be appended with additional, dynamic attributes: See below.

[VALUE] include the attribute values as determined by the user of the Console. See below.

Category	[ATTRIBUTE]	Description [ATTRIBUTE VALUE]
User	email	Email address
	password	User's password
	first_name	User's first name
	last_name	User's last name
State	name	State name
City	name	City name
	state_id	State ID
Amenity	name	Amenity name
Place	city_id	Location's city ID
	user_id	Owner's ID
	name	Location's name
	description	Location's description
	number_rooms	Number of rooms at place
	number_bathrooms	Number of bathrooms at place
	max_guest	Number of guests at place
	price_by_night	Rental price per day
	latitude	Latitude of location
	longitude	Longitude of location
	amenity_ids	Amenity of location
Review	place_id	Place id of the review
	user_id	User id of review writer
	text	Text of location review

Testing

The code was tested using "unittest" in the AirBnB_clone/tests/ directory using the command:

~/AirBnB_clone$ python3 -m unittest discover tests

Credits

HAirBnB is owned and maintained by Minas Anton (@minas_anton) and Felicia Hsieh (@feliciahsiehsw). You can reply to us and to @holbertonschool on Twitter for more updates on this project and our forked projects.

License

HAirBnB is released under the MIT license. See LICENSE for details.