momotsow/TDD-project

📗 Table of Contents

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

📖 [TDD project]

In this project we will implement a class with some methods, but we will do it by doing test-driven development (TDD). The idea is to write tests first and then the code. This will be verified in our commits history, so it is important to use the proper sequence.

🛠 Built With

• Ruby👌
• OOP ruby
• Rspec test

Tech Stack

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

• Write unit tests using Rspec.👌
• Understand an existing codebase in a way that allows for adding tests💯
• Write Rspec unit tests with mocks.👌

(back to top)

🚀 Live Demo

Comming soon.

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need a pc and install ant editor you prefer💯

Setup

Clone this repository to your desired folder:

Example commands:

  cd TDD-project
  git clone https://github.com/vanelnw/TDD-project.git

Install

Install this project with:

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

rspec ./spec/solver_spec.rb

Deployment

You can deploy this project using:

Using : Netlify or Render

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

• GitHub: Osama Ashraf
• Twitter: Osama Ashraf
• LinkedIn: Osama Ashraf

👤 Vanel Nwaba

• GitHub: vanelnw
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Add more methods and attributes to the Person and Student classes. Create additional classes that inherit from Person, such as Teacher and Parent.💯 Implement functionality to store and retrieve Person and Student objects from a database.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project just give me a star to the project😊

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this opportunity.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)