Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gardimy/oop-school-library
https://github.com/gardimy/oop-school-library
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gardimy/oop-school-library
- Owner: Gardimy
- License: mit
- Created: 2023-08-08T00:48:13.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-08-17T17:59:51.000Z (over 1 year ago)
- Last Synced: 2023-08-17T19:26:12.257Z (over 1 year ago)
- Language: Ruby
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TDD Project
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**TDD Project** In this project, I implement a class with some methods, but I do it by doing test-driven development (TDD).
## 🛠 Built With
Client
### Key Features
- Unit tests with Rspec
- TDD project
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - IDE
> - Etc
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/Gardimy/OOP-school-library.git
```
### Install
Install this project with:
```sh
cd OOP-school-library
bundle install
```
### Usage
To run the project, execute the following command:
```sh
ruby main.rb
```
### Run tests
To run tests, run the following command:
```sh
rspec spec/
```
...
> 👤 **Gardimy Charles**
- GitHub: [@Gardimy](https://github.com/Gardimy)
- Twitter: [@gardyelontiga45](https://twitter.com/gardyelontiga45)
- LinkedIn: [Gardimy charles](https://www.linkedin.com/in/gardimy-charles)
- TDD project
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Gardimy/OOP-school-library/issues).
If you like this project please give me a start and share my portfolio to recruters!
I would like to thank to [microverse](https://www.microverse.org/) For teaching me the database and more things.
This project is [MIT](./LICENSE) licensed.