Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mailsg/tdd-project

Implement a class with some methods, but by doing test-driven development (TDD). Idea is to write tests first and then the code.
https://github.com/mailsg/tdd-project

Last synced: 7 days ago
JSON representation

Implement a class with some methods, but by doing test-driven development (TDD). Idea is to write tests first and then the code.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Test Driven Development (TDD) Project

**TDD Project** is demonstration to write unit tests using Rspec. Understand an existing codebase in a way that allows for adding tests. Write Rspec unit tests with mocks. Understand the TDD concept.

## 🛠 Built With

### Tech Stack

Ruby

### Key Features

- **Solver Class**
- **Factorial/Reverse/Fizzbuzz Methods**
- **TDD**

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

```sh
IRB
```

### Setup

Clone this repository to your desired folder:

```sh
git clone [email protected]:mailsg/TDD-Project.git
cd TDD-Project
```

### Install

Install this project with:

```sh
cd TDD-Project
IRB
```

### Usage

To run the project, execute the following command:

```sh
ruby main.rb
```

### Run tests

To run tests, run the following command:

```sh
test file.rb
```

(back to top)

## 👥 Authors

👤 **Sandeep Ghosh**

- GitHub: [@mailsg](https://github.com/mailsg)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/sandeep0912/)

👤 **David Katende**

- GitHub: [@katended](https://github.com/katended)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/katendedavid/)

(back to top)

## 🔭 Future Features

- [ ] **Write a Test**
- [ ] **Run the test**
- [ ] **News around the chosen topic**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project kindly leave a star on the repo.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse giving me this opportunity to showcase my development skills. Also, I would like to thank the Open Source Community to provide vast resources that helped me reach to where I am now.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)