deprov447/median-api repository overview

⁠Median API

A GraphQL based feature rich blogging API.

---

⁠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.

⁠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.

⁠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⁠)

---

⁠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 :)

---

⁠License

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