Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

This backend aims at supporting dynamic form configuration and also API to retrive the config as json from teh backend to use it accordingly on the frontend through REST APIs.

The data is stored in files due to the small size of the project and limited external libraries have been used to maintain the simplicity. This can later be extended with external libraries as required.

The project is compiled using bun and it needs to be installed before proceeding.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

The project requires bun and it can be installed using

• bun

  npm install bun@latest -g

To check if bun is installed corretly, please check the version of bun.

• bun

  bun --version

Please look at https://bun.sh/ for any further clarification on bun installation.

Installation

1. Clone the repo

   git clone https://github.com/SlitheryMender/landeed-takehome-be

2. To install the dependencies of the project

• install dependencies

  bun install.

3. To change the port, please modify the index.ts file and replace port 8080 with your port number. By default, this project uses 8080 port.

(back to top)

Usage

To start the project,

bun index.ts

(back to top)

Contact

Bharath Reddy - [email protected]

Project Link: https://github.com/SlitheryMender/landeed-takehome-be

(back to top)