Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmdadl/airbnb_clone
https://github.com/ahmdadl/airbnb_clone
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ahmdadl/airbnb_clone
- Owner: ahmdadl
- Created: 2023-08-15T18:51:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-15T18:57:41.000Z (over 1 year ago)
- Last Synced: 2024-04-30T17:48:38.995Z (8 months ago)
- Language: Python
- Size: 222 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
HolbertonBnB
An AirBnB clone.
---
## Description :label:
HolbertonBnB is a complete web application, integrating database storage, a back-end API, and front-end interface in a clone of AirBnB.
This team project is part of the (Alx) Holberton School Software Engineering program.
It represents the first step towards building a full web application.
This first step consists of:
- a custom command-line interface for data management,
- and the base classes for the storage of this data.
## Usage 💻
The console works both in interactive mode and non-interactive mode, much like a Unix shell.
It prints a prompt **(hbnb)** and waits for the user for input.
Command | Example
------- | -------
Run the console | ```./console.py```
Quit the console | ```(hbnb) quit```
Display the help for a command | ```(hbnb) help ```
Create an object (prints its id)| ```(hbnb) create ```
Show an object | ```(hbnb) show ``` or ```(hbnb) .show()```
Destroy an object | ```(hbnb) destroy ``` or ```(hbnb) .destroy()```
Show all objects, or all instances of a class | ```(hbnb) all``` or ```(hbnb) all ```
Update an attribute of an object | ```(hbnb) update ""``` or ```(hbnb) .update(, , "")```
### Interactive mode (example)
```bash
$ ./console.py
(hbnb) help
Documented commands (type help ):
========================================
EOF help quit
(hbnb)
(hbnb)
(hbnb) quit
$
```
### Non-interactive mode (example)
```bash
$ 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)
$
```
## Testing :straight_ruler:
Unittests for the HolbertonBnB project are defined in the [tests](./tests)
folder. To run the entire test suite simultaneously, execute the following command:
```
$ python3 unittest -m discover tests
```
Alternatively, you can specify a single test file to run at a time:
```
$ python3 unittest -m tests/test_console.py
```
## Authors :black_nib:
* **Atabong Cecilia** <[cecilia-89](https://github.com/cecilia-89)>
* **Ijabadeniyi Ifedayo** <[Adeniyii](https://github.com/Adeniyii)>