Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qwibbler/hazapp-backend
Backend for Hazapp project
https://github.com/qwibbler/hazapp-backend
api database
Last synced: 14 days ago
JSON representation
Backend for Hazapp project
- Host: GitHub
- URL: https://github.com/qwibbler/hazapp-backend
- Owner: qwibbler
- License: mit
- Created: 2022-12-08T00:16:47.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-03-25T00:25:08.000Z (8 months ago)
- Last Synced: 2024-10-10T10:20:55.460Z (about 1 month ago)
- Topics: api, database
- Language: Ruby
- Homepage: https://hazapp.ztree.pk/
- Size: 281 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**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.
Client
Server
Database
- **Stores all the inputted information from Hazapp.**
- **Stores any inputted information without needing to update the database.**
- **Allows the data to be fetched later.**
- [Live Demo Link](http://170.64.146.104)
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](https://www.ruby-lang.org/en/documentation/installation/). Next, you will need to install rails if you don't already have it:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]:qwibbler/Hazapp-backend.git
```
### Install
Install this project with:
```sh
cd my-project
gem install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
👤 **Author1**
- GitHub: [@qwibbler](https://github.com/qwibbler)
- Twitter: [@hmemaz](https://twitter.com/hmemaz)
- LinkedIn: [Humaira Zaman](https://linkedin.com/in/humaira-zaman)
- [ ] **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.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please feel free to contribute.
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.
- **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!
This project is [MIT](./LICENSE) licensed.