Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/harshsinghvi/queapi

Que Implementation Using API in Python.
https://github.com/harshsinghvi/queapi

api flask mongodb python que rest rest-api

Last synced: about 1 month ago
JSON representation

Que Implementation Using API in Python.

Host: GitHub
URL: https://github.com/harshsinghvi/queapi
Owner: harshsinghvi
License: mit
Created: 2020-11-21T12:58:29.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-03-20T05:31:49.000Z (almost 4 years ago)
Last Synced: 2023-03-05T14:27:43.246Z (almost 2 years ago)
Topics: api, flask, mongodb, python, que, rest, rest-api
Language: HTML
Homepage: https://queapi.vercel.app/
Size: 32.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🔥 [QueAPI](https://stackapi.projects.harshsinghvi.com/)

Que Implementation Using API in Python.

> A Queue is a linear structure which follows a particular order in which the operations are performed. The order is First In First Out (FIFO). A good example of a queue is any queue of consumers for a resource where the consumer that came first is served first. The difference between stacks and queues is in removing. In a stack we remove the item the most recently added; in a queue, we remove the item the least recently added.

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](hhttps://github.com/harshsinghvi/queapi)

[![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://github.com/harshsinghvi/queapi/blob/master/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/harshsinghvi/queapi)

[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/harshsinghvi/)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/harshsinghvi/UniversalGPIO/graphs/commit-activity)

[![GitHub forks](https://img.shields.io/github/forks/harshsinghvi/UniversalGPIO.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/harshsinghvi/queapi/network/)

[![GitHub stars](https://img.shields.io/github/stars/harshsinghvi/UniversalGPIO.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/harshsinghvi/queapi/stargazers/)

[![GitHub watchers](https://img.shields.io/github/watchers/harshsinghvi/UniversalGPIO.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/Naereen/harshsinghvi/queapi/watchers/)

## 🚀 Deployments

* **Production Build** [https://quekapi.vercel.app](https://queapi.vercel.app)

> Check out Latest Production Version [https://queapi.vercel.app](https://queapi.vercel.app) (Using Serverless Functions and MongoDB).

* Old deployment [https://queapi-app.herokuapp.com/](https://queapi-app.herokuapp.com/) (Old with some Bugs).

## 📘 API Documentation

| Resource        | Parameters     | Response     | Description |

| --------------- | -------------- | ------------ | ----------- |

| `/`             | `None`         | Html         | Web App to visualize QueAPI.    |

| `GET /que`      | `None`         | Json         | Get complete queue in Json format. |

| `GET /get`      | `None`         | Json         | POP the element in the Que.      |

| `GET /put`      | `data`         | Json         | PUSH an element in the Que (`/push?data=`). |

## Usage

* Clone the repo `git clone https://github.com/harshsinghvi/stackapi && cd stackapi`

* Edit `sample.config.py`

  - Change the mongo MONGO_DB_URI

  - Rename to *`config.py`*

  - `mv sample.config.py config.py`

* Install depndencies `pip install -r requirements.txt`

* Run flask server `python index.py`

> __[Optional]__ To deploy it to vercel using serverless functions Install **Vercel cli** and deploy to production by running `vercel --prod`.

## ✨ Features

* Serverless

* Made Using JAM Stack

* Static Web UI

## 👾 Contributors

### 👨‍💻[Harsh Singhvi](https://harshsinghvi.com)

[![Twitter][1.1]][1]

[![Facebook][2.1]][2]

[![Github][3.1]][3]

[![LinkedIn][4.1]][4]

[1.1]: http://i.imgur.com/wWzX9uB.png (twitter icon without padding)

[2.1]: http://i.imgur.com/fep1WsG.png (facebook icon without padding)

[3.1]: http://i.imgur.com/9I6NRUm.png (github icon without padding)

[4.1]: https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/linkedin-3-16.png (LinkedIn icon without padding)

[1]: http://www.twitter.com/harshsinghvi29

[2]: http://www.facebook.com/insomniaccoderharsh

[3]: http://www.github.com/harshsinghvi

[4]: https://www.linkedin.com/in/harsh-singhvi/

## 📜 Refrences

* [Deploying a Serverless Flask app to Vercel](https://dev.to/andrewbaisden/how-to-deploy-a-python-flask-app-to-vercel-2o5k)

* [Env Variables in Python](https://www.askpython.com/python/environment-variables-in-python)