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

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

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/frempongdev/tdd-project
• Owner: frempongdev
• Created: 2023-05-04T21:55:58.000Z (about 3 years ago)
• Default Branch: dev
• Last Pushed: 2023-05-05T11:42:06.000Z (about 3 years ago)
• Last Synced: 2024-12-08T21:27:01.891Z (over 1 year ago)
• Language: Ruby
• Size: 16.6 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)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 TDD Project  

**TDD Project** is a Ruby application that has specifically implemented the Test Driven Development model in writing out code. The tests are written first and the methods and crafted to pass all the testing examples and cases.

## 🛠 Built With 

- Ruby

### Tech Stack 

### Key Features 

- **[This project has a Solver class with 3 methods]**

- **[The solver class has a  factorial method to get factorial of a number]**

- **[The solver class has a  reverse method which reverses a string input]**

- **[The solver class has a fizzbuzz method with implement the fizzbuzz logic]**

 **[Refactored code to follow SOLID principles during testing]**

(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:

- [git](https://git-scm.com/downloads): A tool for managing source code

- [Visual Studio Code](https://code.visualstudio.com/): A source code editor

### Setup

- Clone this repository to your desired folder: https://github.com/frempongdev/TDD-project.git

- Run bundle install to install the dependencies.

### Install

Install this project with:

-  cd TDD-project

-  ubuntu version 22 or higher

### Usage

To run the project, execute the following command:

- rspec spec/solver_spec.rb

### Run tests

To run tests, run the following command:

- Run robocop . 

### Deployment

You can deploy this project using:

- Github pages

Github pages

follow these steps for example


(back to top)


## 👥 Author 

👤 **Frempong**

- GitHub: [@frempongdev](https://github.com/frempongdev)

- Twitter: [@knobaddy](https://twitter.com/knobaddy)

- LinkedIn: [Samuel knower Amankwaa-Frempong](https://www.linkedin.com/in/frempongdev/)

👤 **Jonas Nuta Wallah**

- GitHub: [@jonas-45](https://github.com/jonas-45)

- Twitter: [@jonaswullah](https://twitter.com/jonaswullah)

- LinkedIn: [jonas-wullah](https://linkedin.com/in/jonas-wullah)

(back to top)


## 🔭 Future Features 

- We will create more test examples to make methods robust

- We will add a TDD for implementing fibunacci series

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/frempongdev/TDD-project/issues).

(back to top)


## ⭐️ Show your support 

- Give a ⭐️ if you like this project and kindly support by suggesting changes by forking and pull requests.

(back to top)


## 🙏 Acknowledgments 

We would like to appreciate [Microverse](https://www.microverse.org/) for providing the resources and the platform for me to be a Professional full-stack developer.

(back to top)


## 📝 License 

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

(back to top)