https://github.com/nuuxcode/airbnb_clone
AirBnB clone project, a full web application that mimics some functionalities of the popular accommodation rental platform, Airbnb.
https://github.com/nuuxcode/airbnb_clone
Last synced: 3 months ago
JSON representation
AirBnB clone project, a full web application that mimics some functionalities of the popular accommodation rental platform, Airbnb.
- Host: GitHub
- URL: https://github.com/nuuxcode/airbnb_clone
- Owner: nuuxcode
- Created: 2023-08-06T12:48:12.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-20T19:55:17.000Z (almost 3 years ago)
- Last Synced: 2025-11-09T01:15:04.646Z (7 months ago)
- Language: HTML
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# AirBnB clone - The console
Welcome to the AirBnB Clone Console! This is the first step towards building the AirBnB clone project, a full web application that mimics some functionalities of the popular accommodation rental platform, Airbnb.
## Contents:
* [1 Introduction](#1-Introduction)
* [2 Tools](#2-Tools)
* [3 Installation](#3-Installation)
* [4 Testing](#4-Testing)
* [5 Usage](#5-Usage)
* [6 Authors](#6-Authors)
* [7 License](#7-license)
# ``1-Introduction``
Team project to build a clone of [AirBnB](https://www.airbnb.com/).
## Overview
The AirBnB Clone Console is a Python-based command-line interface (CLI) that allows you to manage AirBnB objects, such as users, states, cities, places, and more. With this console, you can perform various operations on these objects, including creating, retrieving, updating, and deleting them.
The console will perform the following tasks:
* create a new object
* retrive an object from a file
* do operations on objects
* destroy an object
## ``2-Tools``
* Style :
* [PEP8](https://pep8.org/)
## ``3-Installation``
1. Clone this GitHub repository to your local machine.
`git clone https://github.com/nuuxcode/AirBnB-Clone.git`
2. Navigate to the project directory.
`cd AirBnB-Clone`
3. Execute the console.
`./console.py`
### Execution
Interactive mode
```
$ ./console.py
(hbnb) help
Documented commands (type help ):
========================================
EOF help quit
(hbnb)
(hbnb)
(hbnb) quit
$
```
Non Interactive mode
```
$ 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)
$
```
## ``4-Usage``
* Start the console in interactive mode:
```bash
$ ./console.py
(hbnb)
```
* Use help to see the available commands:
```bash
(hbnb) help
Documented commands (type help ):
========================================
EOF all count create destroy help quit show update
(hbnb)
```
* Quit the console:
```bash
(hbnb) quit
$
```
* create
> *Creates a new instance of a given class. The class' ID is printed and the instance is saved to the file file.json.*
```bash
(hbnb) create BaseModel
57262839-51d7-4a9a-93e2-35ed8e91d823
$
```
* show
> *Deletes an instance of a given class with a given ID.*
> *Update the file.json*
```bash
(hbnb) show BaseModel 57262839-51d7-4a9a-93e2-35ed8e91d823
[BaseModel] (57262839-51d7-4a9a-93e2-35ed8e91d823) {'id': '57262839-51d7-4a9a-93e2-35ed8e91d823', 'created_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412265), 'updated_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412357)}
(hbnb)
(hbhb)
```
* all
> *Prints all string representation of all instances of a given class.*
> *If no class is passed, all classes are printed.*
```bash
(hbnb) all
[BaseModel] (57262839-51d7-4a9a-93e2-35ed8e91d823) {'id': '57262839-51d7-4a9a-93e2-35ed8e91d823', 'created_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412265), 'updated_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412357)}
(hbnb) all BaseModel
[BaseModel] (57262839-51d7-4a9a-93e2-35ed8e91d823) {'id': '57262839-51d7-4a9a-93e2-35ed8e91d823', 'created_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412265), 'updated_at': datetime.datetime(2023, 8, 13, 14, 19, 19, 412357)}
```
* destroy
>*Deletes an instance of a given class with a given ID.*
>*Update the file.json*
```bash
(hbnb) destroy
** class name missing **
(hbnb) destroy BaseModel
** instance id missing **
(hbnb) destroy BaseModel 57262839-51d7-4a9a-93e2-35ed8e91d823
(hbnb) all
[]
```
* count
> *Prints the number of instances of a given class.*
```bash
(hbnb) create User
ce5f7ac5-4b2e-4c90-933d-6c78e69ab1c7
(hbnb) create User
dd697519-4ac9-42e0-80e2-fa7b3ac61193
(hbnb) create User
52c4036b-f018-49d0-8d93-d7a2d56bcdad
(hbnb) count User
3
```
## ``5-Testing``
* unittest module
* File extension ``` .py ```
* Files and folders star with ```test_```
* Organization:for ```models/base.py```, unit tests in: ```tests/test_models/test_base.py```
* Execution command: ```python3 -m unittest discover tests```
* or: ```python3 -m unittest tests/test_models/test_base.py```
### run TEST interactive mode
```bash
echo "python3 -m unittest discover tests" | bash
```
### run TEST non-interactive mode
To run the tests in non-interactive mode, and discover all the test, you can use the command:
```bash
python3 -m unittest discover tests
```
## ``6-Authors``
- [Soumia Ouzat](https://github.com/SouaOui)
- [Mounssif Bouhlaoui](https://github.com/nuuxcode)
## ``7- License``
This project is licensed under the MIT License - see the [LICENSE](https://chat.openai.com/LICENSE) file for details.