fmdapi-node-weaver v1.0.0

The @mindfiredigital/fmdapi-node-weaver is a tool that allows developers to integrate multi page document editors built on top of Canvas using React.

NOTE: : The endpoints shown in figure are for demo purpose, these are not actual endpoints. For actual Data API endpoint, refer documentation

Table of Contents

• Features
• Installation
• Getting Started
• Contributing
• License

Features

• No Mandatory Session Token: Unlike the standard FileMaker Data API, the Bundler does not require a validated session token for every API call. It handles authentication using Basic Auth, generating a new session token if one is not provided or if the session has expired.

• Uniform API Endpoints: Each API endpoint in the Bundler follows a consistent style, simplifying usage and reducing confusion. Regardless of the specific API functionality, you'll find a consistent method structure.

• Automatic Session Management: Users don't need to worry about re-validating their session each time they interact with the API. The Bundler automatically manages sessions by using Basic Auth as an authentication header.

Installation

To download the project @mindfiredigital/fmdapi-node-weaver into your system, use the following command:

git clone https://github.com/mindfiredigital/fmdapi-node-weaver

Getting Started

• Initialization: Install the dependencies from the package.json:

npm i

or

yarn

• Launch the server

node app.js

Docker Integration

To containerize your application using Docker, follow these steps:

• Build Docker Image: Build the Docker image using the provided Dockerfile:

docker build -t fmdapi-node-weaver .

• Run Docker Container: Run the Docker container, mapping the desired port (e.g., 3000) to the container's port:

docker run -p 3000:3000 fmdapi-node-weaver

Contributing

We welcome contributions from the community. If you'd like to contribute to the fmdapi-node-weaver npm package, please follow our Contributing Guidelines.

License

Copyright (c) Mindfire Digital llp. All rights reserved.

Licensed under the MIT license.