DEV Community

Vishal
Vishal

Posted on

Ready to Serve - A plug and play backend server

What I built

A backend server for people who don't want to write backend code.

Ready to Serve lets you set up a server with functionalities that you want by using plugins to offer those functionalities and map them to endpoints. Plugins are just jar files.

Website

https://bbloggsbott.github.io/ready-to-serve

GitHub logo BBloggsbott / ready-to-serve

A backend server for people who don't want to write backend code.

ready-to-serve

A backend server for people who don't want to write backend code.

Ready to Serve lets you set up a server with functionalities that you want by using plugins to offer those functionalities and map them to endpoints.

Set up

Download and run readytoserve-1.0.0.jar file and it will create the necessary files and directories for you during the first run. You can then customize where you keep the necessary data by editing the settings.json file.

What are plugins?

Plugins are Jar files. You use a plugin config file to configure aspects of the plugin and mapp it to an endpoint you want. The config file uses a .yml syntax.

Here is a sample plugin config:

- name: Sum
  jarfile: helloworld.jar
  method: com.bbloggsbott.helloworld.HelloWorld.getSum
  endpoint: /sum
  requestType: GET
  args
    - name: a
      type: int
      requestParam: true
    - name: b
      type: 
Enter fullscreen mode Exit fullscreen mode

Background

It originally started as a much simpler server that could serve static markdown content with live-reload so users can edit the markdown files and the changes (including endpoint changes) will be reflected without the need to restart the server. Then I wanted it to be able to let the user serve any functionality they want. So I built it so it can load any jar file and use the methods in it and link them to endpoints.

Top comments (0)