AssaultKoder95 / feather-js-demo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feather.js Demo App

This is a demo project showcasing the usage of Feather.js, a lightweight web framework for building real-time applications.

Getting Started

To get started with this project, follow the steps below:

  1. Clone the repository:

    git clone https://github.com/AssaultKoder95/feather-js-demo
  2. Install the dependencies:

    cd feather-js-demo
    npm install
  3. Start the server:

    npx ts-node src/index.ts
  4. The application should be running on http://localhost:4000.

API Usage

This demo project exposes a RESTful API for echoing data back to the client. Here's an example of how to use the API:

Echo the sent data

Using the endpoint localhost:4000/echo with method specified as POST, when triggered with following data :

{
	"loantube": "fintech firm",
	"location": "united kingdom",
	"developer": "Abhishek",
	"date": "2nd April 2024 - 2:30 am"
}

should return the same data to the user.

Demo

Screen.Recording.2024-04-02.at.2.21.16.AM.mov

Specifications

Modules used in the application with versions:

feathers": "5.0.24"
koa": "5.0.24"

About

License:GNU General Public License v3.0


Languages

Language:TypeScript 100.0%