An open API service indexing awesome lists of open source software.

https://github.com/iamsjunaid/tdd


https://github.com/iamsjunaid/tdd

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 About ](#-about-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage ](#usage-)
- [Test ](#test-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgement ](#acknowledgement)
- [📝 License ](#-license-)

# 📖 About
_**TDD**_ built with [Ruby](https://www.ruby-lang.org/en/). In this project We have created:

1. `solver.rb`
- This class contains the functions implemented in the `solver_spec.rb` file.

2. `solver_spec.rb`
- This file container the test cases for the functions implemented in the `solver.rb` file.
- It consist of 7 test cases.

We have created this project to learn and practice the following:

- [x] Ruby
- [x] TDD(Test Driven Development)
- [x] RSpec

## 🛠 Built With

### Tech Stack

Client

### Key Features

- Test Driven Development.
- Faster Development.

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- [Ruby](https://www.ruby-lang.org/en/) installed and running. To get more information, read the [installation instructions](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md).
- You should be able to use [IRB](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Features).
### Setup

Clone this repository to your desired folder:

```
git clone git@github.com:iamsjunaid/tdd.git
cd tdd
```

### Install

Install project dependencies with:

```
bundle install
```

### Usage

To run the project, instantiate the class files in `main.rb` and execute the following command:

```
ruby solver.rb
```

### Test

To run the tests, execute the following command:

```
bundle exec rspec
```

(back to top)

## 👥 Authors
👤 **Junaid Syed**

- GitHub: [@iamsjunaid](https://github.com/iamsjunaid)
- LinkedIn: [@JunaidAhmedSyed](https://www.linkedin.com/in/junaidahmedsyed/)

👤 **Nahid Raihan Sardar**

- GitHub: [@githubhandle](https://github.com/Nahid1911)
- Medium: [Medium](https://medium.com/@nahid.raihan)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nahidraihan/)
- Twitter: [Twitter](https://twitter.com/Nahid1911)

(back to top)

## 🔭 Future Features

- I'll be adding some additional methods and the test cases to this project.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/iamsjunaid/tdd/issues).

(back to top)

## ⭐️ Show your support

If you like this project and want to support me make cooler projects Give this project a Star.

(back to top)

## 🙏 Acknowledgments

I would like to thanks [Microverse](https://www.microverse.org/).

(back to top)

## 📝 License

This project is [MIT](https://github.com/iamsjunaid/tdd/blob/dev/LICENSE) licensed.

(back to top)