killy10o10/fitmeup-backend

Fit Me Up - Backend

📗 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 (OPTIONAL)
• 📝 License

📖 Fit Me Up Backend

Fit me up backend is an api based application built with rails with an intention of being consumed by the front end version that is; Fit Me Up frontend.

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• JWT Authentication
• API versioning
• Scalable database design

(back to top)

🚀 Live Demo

• N/A

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

• Ruby and Rails to be installed on your machine
• You need to be having postgresql database installed as well

Setup

Clone this repository to your desired folder: run the command below

    git clone [email protected]:barakadanny/FitMeUp-Backend.git

Install

Install this project with: run the command below to install all gems for the project

    bundle install

Usage

To run the project, execute the following command: run the code below in order to start the local server

    rails server

Run tests

To run tests, run the following command: Our tests were written with rspec, and you can use the code below in order to run the tests

    rspec spec

Deployment

You can deploy this project using render

(back to top)

👥 Authors

Mention all of the collaborators of this project. 👤 Author1 👤 Quami Killy

• GitHub: @killy10o10
• Twitter: @Quami_Killy
• LinkedIn: @Kingsley Okine

👤 Muskan Gupta

• GitHub: @github
• Twitter: @twitter
• Linkedin:Username

👤 Kibirige John

• Github: John-Kibrige
• Twitter: kibirigejohn005
• LinkedIn: Kibirige John

👨‍💻 Baraka Danny

• GitHub: @barakadan
• LinkedIn: danny baraka

👨‍💻 Aakash Verma

• GitHub: @skyv26
• Twitter: @vrma_aakash
• LinkedIn: skyv2022

(back to top)

🔭 Future Features

• Write a documentation for our api
• Write more tests for the api
• Optimize database queries and limit associations for better modularity

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project If you like this project...

(back to top)

🙏 Acknowledgments

We give credit to Murat Korkmaz on behance for his design was essential in the implementation of this project

(back to top)

❓ FAQ

• What is the best way to test my api?
  • This is easily done using postman, a tool that can help you interact with your api.
• Can i use both JWT and devise
  • No, you ought to choose at least after weighing the advantages and disadvantages of each

(back to top)

📝 License

This project is MIT licensed.

(back to top)