Git Product home page Git Product logo

dev-quotes-api's Introduction

dev-quotes-api

The dev-quotes-api is a synchronous REST API made using Flask, and HarperDB for showcasing community quotes from developers and possibly in the future this might be connected to different services, Just for fun :P The API is currently in development and might be launched soon. This is an opensource project under the "BSD 3-Clause" License.

Demo of JSON output

Deployment Status: Online(in development)

https://dev-quotes-api.herokuapp.com/

PLANS-

  • GET method for random quotes
  • GET method for random quotes from one author
  • GET method for quotes to be fetched by id
  • GET method to get ALL quotes from an author
  • POST method to insert data
  • Add more data in the quote database.
  • Make this async?
  • Better docs and README

NOTE-

This project might be archived and revived with FastAPI/Starlette/aiohttp.web(asynchronous) [*The Flask version would NOT be deleted tho :) ]

dev-quotes-api's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar eddiejaoude avatar vyvy-vi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

dev-quotes-api's Issues

DOCS: Make README

Description

A detailed readme with how to use, and how to run this locally, would be great.
(Maybe even a deploy to Heroku, button?)
Some contributor guidelines also need to be added.

FEAT: add more quotes

Description:

A few more quotes in the db would be great-!
This issue is open for responses. However, keep in mind that there is some level of decency expected from the quotes. (sfw + um let's say non-polarising quotes would be appreciated).

How to suggest quotes?:

This can be done by adding quotes in a file titled quotes.csv(If the file hasn't been made yet, make a new file titled that).
The format suggested would be-

quote, author, categories(in a list)

Example:

"Your value, success, and worth as a developer are NOT determined by green squares on an arbitrary chart. :)", Nicholas Carrigan, ["OpenSource", "Motivation"]

These would be uploaded to the db.
Sadly, at some point I might have to remove the csv files, thus I'll make a contributors chart :)

*If you're the first person to look at this issue, and think that there is a better way to ask for these, it would be great if you could share those. :)

More context:

The csv can be directly plugged to my db(it has methods that support that).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.