katarighe/TDD-Project

This Ruby project implemented a class with methods via test-driven development (TDD) practice.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

TDD Project

The TDD Project is a is a Ruby-built app that revolutionizes library management by making it easy to catalog, track, and lend books to students and teachers.

🛠 Built With

Tech Stack

Ruby

• Ruby
• Rubocop

Key Features

The key features of this project includes.

• A class that represents the entire class.
• A module that represents the implementation of a subset of the functionality.

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

• A code editor (Visual Studio Code is recommended)

• Git and a GitHub account

Setup

Clone this repository to your desired folder by using this 👇️ command :

git clone https://github.com/katarighe/TDD-Project.git

Install

Go to the project directory:

 cd TDD-Project

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

Usage

To run the project, execute the following command:

ruby solver.rb

Run tests

• Tests are not applicable in this project at the moment.

Deployment

• Deployment is not applicable in this project at the moment.

(back to top)

👥 Authors

👤 Mohamed Aden Ighe

• GitHub: @katarighe
• Twitter: @katarighe
• LinkedIn: @mighe

👤 Okari Nyandika

• GitHub: @2004-okari
• LinkedIn: @rooney-okari

(back to top)

🔭 Future Features

Here are some future features that could be added to the TDD Project in the future.

• Integration with other educational tools: SLMS can be integrated with other educational tools, such as learning management systems (LMS) and electronic textbooks, to provide a more seamless learning experience for students.

These are just a few ideas for future features that could be added to the TDD Project module. The specific features that are added will depend on the needs and wants of the users.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

• Project supervised by Microverse
• Creative Commons 4.0 License

(back to top)

📝 License

This project is MIT licensed.

(back to top)