alishabab/kittens-app

In this project, I created kittens app which exposes simple REST api to fetch a kitten or all kittens.

Kittens App

In this project, I created kittens app which exposes simple REST api to fetch a kitten or all kittens.

Built With

• Ruby v2.7.0
• Ruby on Rails v5.2.4.2

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

• Ruby: 2.6.3
• Rails: 5.2.3
• Git

Usage

• Fork/Clone this project to your local machine
• Open folder in your local enviroment and run thes lines of code to get started:

Install gems with:

    bundle install

Setup database with:

   rails db:create
   rails db:migrate

Start server with:

    rails server

Then open a web page and go to port 3000 on your local machine.

Running tests

    bundle exec rpsec --format documentation

Deployment

Follow vendor specific instructions to deploy the application.

Author

👤 Shabab Ali

• Github: @alishabab
• Twitter: @shabab_ali
• LinkedIn: shababali
• Email: shababsaifi@gmail.com

🤝 Contributing

Contributions and feature requests are welcome!

Start by:

• Forking the project
• Cloning the project to your local machine
• cd into the project directory
• Run git checkout -b your-branch-name
• Make your contributions
• Push your branch up to your forked repository
• Open a Pull Request with a detailed description to the development(or master if not available) branch of the original project for a review

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

-The Odin Project