Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmedeid6842/tdd
implement a class with some methods, but firstly doing test-driven development (TDD)
https://github.com/ahmedeid6842/tdd
Last synced: 25 days ago
JSON representation
implement a class with some methods, but firstly doing test-driven development (TDD)
- Host: GitHub
- URL: https://github.com/ahmedeid6842/tdd
- Owner: ahmedeid6842
- License: mit
- Created: 2023-09-07T20:17:38.000Z (about 1 year ago)
- Default Branch: development
- Last Pushed: 2023-09-07T23:25:11.000Z (about 1 year ago)
- Last Synced: 2024-04-06T14:31:54.611Z (7 months ago)
- Language: Ruby
- Size: 10.7 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TDD Project | Ruby
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [TDD Project ](#tdd-project-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
---
**"TDD Project"** consists of creating test cases using the Rspec gem and applying the TDD methodology to a series of methods within a class. The purpose of the project is to practice testing following the best practices and applying a more optimal approach (TDD), which allows obtaining a more stable, clean and maintainable code.
---
Ruby
Rspec gem
---
- Ruby
- Linters
- Rubocop
- Apply TDD to create unit tests
---
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
A code editor (we recommend Visual Studio Code)
Git and a GitHub account
### Setup
Clone this repository to your desired folder by using this 👇️ command :
```
git clone https://github.com/ahmedeid6842/TDD.git
```
### Install
Go to the project directory:
```
cd TDD
```
Before to run the program, verify that you have Ruby installed on your OS running the following command:
```
ruby -v
```
It should show you the version of ruby installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.
[Download and Install Ruby](https://www.ruby-lang.org/en/downloads/)
### Run tests
Run the following command inside the project folder:
```
rspec spec
```
This should display:
```
8 examples, 0 failures
```
This means that all 8 designed test cases have passed successfully.
---
👤 **Nitcelis Bravo**
- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)
👤 **Ahmed Eid**
- GitHub: [Ahmed Eid](https://github.com/ahmedeid6842)
- Twitter: [@ahmedeid2684](https://twitter.com/ahmedeid2684)
- LinkedIn: [Ahmed Eid](https://www.linkedin.com/in/ameid/)
---
Upcoming improvements:
- [x] Create unit tests following TDD methodology
---
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ahmedeid6842/TDD/issues).
---
If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️ if you like this project!
---
I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.
---
This project is [MIT](./LICENSE) licensed.
---