someshium / API

🌐⚡ Game datastore API for klifu.

API

Under Development 🔨

Table of Contents

• Overview
• Getting Started
• contributing
• Documentation

Overview

This is a backbone of Klifu. This acts as a datastore for our game data, which will be priodically changed to update the game.

Getting Started

Klifu API is built on nodejs, and is using express, to run it localy you would need nodeJS installed in you local system. To download NodeJS click here

Installation

To run the application on your local machine follow these steps

• After successfully cloning the repo,
• run npm install to install all the dependencies.
• run npm run dev to start the dev server.

We are using airtable of our data storage so you need to create a .env file and pass these enviorment variables to run the server successfully.

API_KEY=${airtable_api_key}
BASE=${airtable_base_ID}

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

For instructions to start contributing check out Klifu.

Documentation

Visit our API for openapi spec.