Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tigo-cmd/airbnb_clone


https://github.com/tigo-cmd/airbnb_clone

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README 

        
# AirBnB Clone - The Console



AirBnB Clone - The Console is a command-line tool designed to manage and interact with property rental data. This project emulates the basic functionality of Airbnb, allowing you to create, manage, and search for property listings through a user-friendly command-line interface.

# Table of Contents



    Installation

    Usage

    Commands

    Examples

    Contributing

    License



Installation

Requirements



Python 3.6 or later

Clone this repository to your local machine:



````

git clone https://github.com/Tigo-cmd/AirBnB_clone.git

````

Navigate to the project directory:



````

cd AirBnB_clone

````

Run the console:



````

./console.py

````



Now you're ready to start using the AirBnB clone console!

Usage



The console provides a simple, yet powerful, interface for managing property listings. It allows you to create, update, delete, and search for property listings. You can interact with the console by typing in commands and receiving feedback in real-time.

Commands



Here are some of the basic commands you can use in the AirBnB clone console:



    create : Create a new instance of a specified class.



    show  : Display information about an instance.



    destroy  : Delete an instance.



    all : Display a list of all instances or all instances of a specified class.



    update    "": Update an attribute of an instance.



For a full list of available commands and their usage, you can use the help command within the console.

Examples



Here are a few examples of how to use the console:



create a new user:



````

(hbnb) create User

````

    

Show details of a user:

````

(hbnb) show User 

````



List all available users:



Update a user's information:

````

(hbnb) all User

(hbnb) update User  first_name "John"

````

Delete a user:

````

(hbnb) destroy User 

````

More Info

Execution



works in interactive mode:

=======

Usage

How to start the interpreter: First, we clone this repo:



```

$ git clone https://github.com/aliceada96/AirBnB_clone.git

$

```



Then we cd into AirBnb directory:

```

$ cd AirBnB

$

```



We can start the command interpreter interactively:

```

$ ./console.py

(hbnb)

```

To exit the console we can use the command quit or ctrl + D



````

(hbnb) quit

$

````

To get the available list of commands we can enter 'help' onto the CLI.

````

(hbnb) help

````

````

Documented commands (type help ):

========================================

EOF  all  count  create  destroy  help  quit  show  update

````

````

(hbnb) 

``````

We can get more information on a command e.g.,

````

(hbnb) help count

````

Print number of objects from class.

````

(hbnb)

````

We can create an instance of a class, for example:

````

(hbnb) create BaseModel

f8284b8a-27fd-413e-bc0f-e20ae89c17b1

(hbnb)

````

Inspect an instance of a class:

````

(hbnb) show BaseModel f8284b8a-27fd-413e-bc0f-e20ae89c17b1

[BaseModel] (f8284b8a-27fd-413e-bc0f-e20ae89c17b1) ({'id': 'f8284b8a-27fd-413e-bc0f-e20ae89c17b1', 'created_at': datetime.datetime(2023, 10, 15, 21, 27, 18, 991998), 'updated_at': datetime.datetime(2023, 10, 15, 21, 27, 18, 992046)})

(hbnb)

````

Update an instance of a class with various attributes:

````

(hbnb) update BaseModel f8284b8a-27fd-413e-bc0f-e20ae89c17b1 name bonii

(hbnb) show BaseModel f8284b8a-27fd-413e-bc0f-e20ae89c17b1

[BaseModel] (f8284b8a-27fd-413e-bc0f-e20ae89c17b1) ({'id': 'f8284b8a-27fd-413e-bc0f-e20ae89c17b1', 'created_at': datetime.datetime(2023, 10, 15, 21, 27, 18, 991998), 'updated_at': datetime.datetime(2023, 10, 15, 21, 28, 46, 959895), 'name': 'bobii'})

(hbnb)

````

Delete an instance of a class:

````

(hbnb) destroy BaseModel f8284b8a-27fd-413e-bc0f-e20ae89c17b1

(hbnb) show BaseModel f8284b8a-27fd-413e-bc0f-e20ae89c17b1

** no instance found **

(hbnb)

````

````

$ ./console.py

(hbnb) help

````

````

Documented commands (type help ):

========================================

EOF  help  quit



(hbnb) 

(hbnb) 

(hbnb) quit

$



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



$ echo "help" | ./console.py

(hbnb)



Documented commands (type help ):

========================================

EOF  help  quit

(hbnb) 

$

$ cat test_help

help

$

$ cat test_help | ./console.py

(hbnb)



Documented commands (type help ):

========================================

EOF  help  quit

(hbnb) 

$

````

Contributing



We welcome contributions from the community! If you find a bug, have an idea for an improvement, or would like to add new features, please feel free to open an issue or submit a pull request.

License



This project is licensed under the MIT License - see the LICENSE file for details.



Enjoy using the AirBnB Clone - The Console, and happy property management! If you have any questions or need further assistance, feel free to reach out to the project maintainers.



AUTHORS

Nwali Ugonna Emmanuel (Tigo-cmd)