Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamnotnato/myelevator
My ALX Foundations Portfolio Project
https://github.com/iamnotnato/myelevator
Last synced: about 2 months ago
JSON representation
My ALX Foundations Portfolio Project
- Host: GitHub
- URL: https://github.com/iamnotnato/myelevator
- Owner: iamnotnato
- License: mit
- Created: 2023-08-20T06:51:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-16T23:45:32.000Z (12 months ago)
- Last Synced: 2024-01-17T06:47:39.882Z (12 months ago)
- Language: HTML
- Homepage: https://iamnotnato-github-io-d3py.vercel.app
- Size: 11.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> 🚧 **Project : myElevator**
> A visual first step into coding!
> 📝 **Summary:**
> A visual first step into coding!
> ⌨️ **Languages Used :**
> 🖥️ **Workstation:**
Credits :
Image by Freepik
Sound Effect from Pixabay
Elevator Logo Vectors by Vecteezy
George Street Shuffle by Kevin MacLeod | https://incompetech.com/
Music promoted by https://www.chosic.com/free-music/all/
Creative Commons Creative Commons: By Attribution 3.0 License
http://creativecommons.org/licenses/by/3.0/
# myElevator
## Purpose
myElevator is a simple command-line application that simulates an elevator system. It allows users to create elevators, add and remove passengers, and move the elevators up and down.
## Features
* Create and manage multiple elevators
* Add and remove passengers to elevators
* Move elevators up and down
* Display the current status of the elevator system
## Technologies Used
* Python 3.6+
* Click
* rich
## Getting Started
To get started with myElevator, follow these steps:
1. Clone the repository:
```
git clone https://github.com/iamnotnato/myElevator.git
```
2. Install the dependencies:
```
pip install -r requirements.txt
```
3. Run the program:
```
python elevator.py
```
## Usage
To use myElevator, type commands into the command-line interface.
The following commands are available:
* `create elevator`: Creates a new elevator.
* `add passenger`: Adds a passenger to an elevator.
* `remove passenger`: Removes a passenger from an elevator.
* `move elevator`: Moves an elevator up or down.
* `status`: Displays the current status of the elevator system.
* `quit`: Quits the program.
## Contribution Guidelines
Contributions to myElevator are welcome! Please read the [contributing guidelines](https://github.com/iamnotnato/myElevator/blob/main/CONTRIBUTING.md) before submitting a pull request.
## License
myElevator is licensed under the MIT License. See the [LICENSE](https://github.com/iamnotnato/myElevator/blob/main/LICENSE) file for details.
### Contact
For any questions or support, please contact the maintainer through [GitHub](https://github.com/iamnotnato).