qwibbler / Hazapp-backend

Backend for Hazapp project

Hazapp Backend

Sister Project to Hazthenewestapp

📗 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

📖 Hazapp Backend

Hazapp is a private app to help calculate the Haz Masail for countless ladies. This is the database for storing solved masail for record keeping and double checking.

🛠 Built With

Tech Stack

Client

• KotlinJS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Stores all the inputted information from Hazapp.
• Stores any inputted information without needing to update the database.
• Allows the data to be fetched later.

(back to top)

🚀 Live Demo

• Live Demo Link

(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 to first have ruby installed. Next, you will need to install rails if you don't already have it:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [e-mail]:qwibbler/Hazapp-backend.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Author1

• GitHub: @qwibbler
• Twitter: @hmemaz
• LinkedIn: Humaira Zaman

(back to top)

🔭 Future Features

• Admins, Users and Login features.
• Link to jump straight to Hazapp from a Masla.
• Masla groups, to keep one persons ongoing Masla in one place.

(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, please feel free to contribute.

(back to top)

🙏 Acknowledgments

I would like to thank Safarjal without whom this project would never have even started. I would also like to thank Suffah Online for considering this project a worthwhile investment for their time and efforts.

(back to top)

❓ FAQ

• Can I edit a Masla?

  • No, we consider these to be valuable records that should not be changed. Feel free to add the new, correct Masla instead.

• How do I log in to save my Maslas under my name?

  • Unfortunately, we currently have no support for users. We'll be getting right on that, iA!

(back to top)

📝 License

This project is MIT licensed.

(back to top)