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

https://github.com/chandan-devs-tech/tdd-project


https://github.com/chandan-devs-tech/tdd-project

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          

TDD Project


# 📗 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)
- [Usage](#usage)
- [Run tests](#run-tests)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 TDD Project

> The _TDD Project_ is all about building a class and its methods by first creating comprehensive tests that outline the expected behavior. We'll then develop the class code to make these tests pass, resulting in a robust and thoroughly tested class implementation.

## 🛠 Built With

### Tech Stack

> Ruby

### Key Features

- Class named Solver.
- factorial method for calculating factorials.
- reverse method for reversing strings.
- fizzbuzz method following FizzBuzz rules.
- Test-Driven Development (TDD) approach.
- Comprehensive testing for various scenarios.

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

- Laptop
- Github
- Git
- Ruby
- Linters

### Prerequisites

In order to run this project you need:

- Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/).
- Create a repo on your repositores files.
- Clone or make a copy of this repo on your local machine.
- Follow GitHub flow.
- A carefully reading of this README.md is required.

### Setup

Clone this repository to your desired folder:

```
sh
cd my-folder
git clone https://github.com/Chandan-devs-tech/TDD-Project.git
```
### Install

Install this project with:

```
sh
bundle install
```
### Usage

To run the project, run the following command:

```
sh
ruby main.rb
```

### Run tests

To run tests, run the following command:

```
rubocop
rspec spec
```

(back to top)

👤 Chandan Gupta

- GitHub: [@githubhandle](https://github.com/Chandan-devs-tech)
- Twitter: [@twitterhandle](https://twitter.com/ChandanGuptaDev)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chandangupta-devs)

👤 Melkamu Alemawu

- GitHub: [@melkamu12](https://github.com/melkamu12)
- LinkedIn: [melkamu-almawu](https://www.linkedin.com/in/melkamu-almawu/)

(back to top)

## 🔭 Future Features

- Performance Optimization
- Improved Error Handling
- Customizable FizzBuzz Rules
- Additional Math Functions

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Chandan-devs-tech/TDD-Project/issues).

(back to top)

## ⭐️ Show your support

If you like this project,please give us a ⭐️!

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving me the opportunity to learn and grow as a developer.

(back to top)

## 📝 License

This project is [MIT](https://github.com/Chandan-devs-tech/TDD-Project/blob/feature/TDD/MIT.md) licensed.

(back to top)