Skip to content

sumitkolhe/krates

Repository files navigation



Krates

Krates is a free HTTP based JSON storage service. It is meant to be easy to use and easy to self-host. It lets you store, read & modify JSON data over HTTP APIs for FREE.

GitHub repo size GitHub

🔥Features

Simple : Zero configuration required and super easy to use.

💰 Free : Krates is completely free to use and always will be.

🌈 Backend Agnostic : Use krates with a backend server or directly from the browser.

🔐 Protected Krates : Protect you krates from unauthorized access.

🚀 Lightning Fast : Saving your data is just a HTTP request away.

Documentation

Local Setup

Clone the repository to a folder of your choice.

git clone https://github.com/sumitkolhe/krates

This would clone the whole repository onto your machine.

Run locally

The repository contains frontend and backend code as well. You will need to run them separately.

Backend server

You need MongoDB to run this application. If you don't already have MongoDB, go to the official documentation and follow the instructions there.

Once you have MongoDB installed, run

mongo

Install the dependencies

cd krates
npm install

Rename .example.env file to .env and fill all the required variables.

Start the backend server by running

npm run dev

This will start the backend server on port 4000

Frontend server

Install the dependencies

cd krates/dashboard
npm install

Start the frontend server by running

npm run dev

This will start the frontend server on port 3000

✍️ Authors

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.