https://github.com/lorialawrencez/java-elevator
https://github.com/lorialawrencez/java-elevator
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lorialawrencez/java-elevator
- Owner: LoriaLawrenceZ
- License: gpl-3.0
- Created: 2024-02-05T21:50:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T21:54:13.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T11:12:06.379Z (11 months ago)
- Language: Java
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Document Summary
## About the Project
For a brief summary, it can be said that this Java program functions as a simple elevator simulator, featuring a handcrafted interface using javax.swing elements.
Designed to emulate a 9-floor building, including basement levels (ranging from -2 to the sixth floor), the simulation features a single elevator. Users can observe the elevator's movement, current floor, and status.
Notable is the absence of simultaneous operation for two elevators or the implementation of a waiting queue, providing a simplified yet effective exploration of elevator system functionality within a multi-story structure.
Initial Interface
![Product Name Screen Shot][product-screenshot]
The Initial Interface simulates an Apartment, where it's possible to observe some important elements for the simulation.
Elements:
* There is a top line, simulating the building's floors, which can call an elevator
* There are two elevators, one on the left and one on the right
* In each elevator, there are two important pieces of information: the name and the floor it is on, and its status (whether it's in motion, stopped, open, etc.)
### Project Structure
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
* [![Next][Next.js]][Next-url]
* [![React][React.js]][React-url]
* [![Vue][Vue.js]][Vue-url]
* [![Angular][Angular.io]][Angular-url]
* [![Svelte][Svelte.dev]][Svelte-url]
* [![Laravel][Laravel.com]][Laravel-url]
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
* [![JQuery][JQuery.com]][JQuery-url]
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```
### Installation
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
## design
- [x] Add Changelog
- [x] Add back to top links
- [ ] Add Additional Templates w/ Examples
- [ ] Add "components" document to easily copy & paste sections of the readme
- [ ] Multi-language Support
- [ ] Chinese
- [ ] Spanish
See the [open issues](https://github.com/OZimbres/Java-Elevator/issues) for a full list of proposed features (and known issues).
## Challenges
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
## Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
* [Img Shields](https://shields.io)
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)
[contributors-shield]: https://img.shields.io/github/contributors/OZimbres/Java-Elevator.svg?style=for-the-badge
[contributors-url]: https://github.com/OZimbres/Java-Elevator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/OZimbres/Java-Elevator.svg?style=for-the-badge
[forks-url]: https://github.com/OZimbres/Java-Elevator/network/members
[stars-shield]: https://img.shields.io/github/stars/OZimbres/Java-Elevator.svg?style=for-the-badge
[stars-url]: https://github.com/OZimbres/Java-Elevator/stargazers
[issues-shield]: https://img.shields.io/github/issues/OZimbres/Java-Elevator.svg?style=for-the-badge
[issues-url]: https://github.com/OZimbres/Java-Elevator/issues
[license-shield]: https://img.shields.io/github/license/OZimbres/Java-Elevator.svg?style=for-the-badge
[license-url]: https://github.com/OZimbres/Java-Elevator/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/lorenzo-oliveira-zimbres-818724229/
[product-screenshot]: readmeContent/interfacePrincipal.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com