Giter Club home page Giter Club logo

median-api's Introduction

GitHub Workflow Status (branch) GitHub deployments

GitHub code size in bytes Docker Image Size (latest by date) GitHub

A GraphQL based feature rich blogging API.

See full documentation HERE for API docs, configuration and deployment options.


Features

Lightweight

Median API is very lightweight as compared to other REST based API. And the main reason is that you get only the content you request for, which is not possible (or atleast cumbersome) in REST architecture.

For example if you only want titles of top 3 blogs, you can just pass a query like this and in response you only get those 5 respective titles:

recording89f7c02ede6efed0.gif

Platform Agnostic

The API is fully platform agnostic, ie any client on any platform can use this API. These include React application, Angular, Electron, Flutter, Native desktop apps on Qt etc. The possibilities are endless.

Even if your platform doesnt have a library to make graphQL based request, you can use Median. See: (a blog reg this)

Open Source

The API is fully open source, you can freely host it on your own server with all the customizations you want.


Local Setup

  • Clone this repo: git clone https://github.com/deprov447/median-server
  • Run npm install
  • Setup environment variables :
    • Create a .env file in root directory of the project
    • Insert these 3 keys/value pairs :
      • PORT : < Port on which server will listen >
      • DB_ADDR : < Mongo database connection URI >
      • SECRET : < Secret key for signing auth tokens >
  • Start the server: npm start
  • Start requesting from a client (eg: playground)

Or the same can be done using docker also: docker pull deprov447/median-api


Buy me a coffee

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)

Buy Me A Coffee


License

This project is licensed under the terms of the MIT license.

median-api's People

Contributors

deprov447 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

median-api's Issues

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.