Skip to content

mugishap/file-manipulations-sdk

Repository files navigation

Project logo

file-manipulations-sdk

Status GitHub Issues GitHub Pull Requests License


Few lines describing your project.

📝 Table of Contents

🧐 About

This is a simple API that allows you to manipulate files. This is mostly for excel file where you can manipulate the data using mysql database. It is currently under construction

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

🚀 Demo

This is a demo of how the API works Watch the video

Prerequisites

What things you need to test of use the API and how to install prerequisites.

Great API tester such as Postman, Thunder Client or Postcode.

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

Go to the '/getauthentication' to get Authorization key

And then

you can use the key to get the data and manipulate any data

Example

```
curl -X GET -H "Authorization: Bearer <your_key>" https://xcel-db-manager.herokuapp.com/getalldata
```

🔧 Running the tests

How to run the automated tests for this system.

```
curl -X GET -H https://xcel-db-manager.herokuapp.com/getauthentication
```

🎈 Usage

You can use the API to manipulate the data. BaseURL is https://xcel-db-manager.herokuapp.com/

📝 Endpoints

Get authentication key

curl -X GET https://xcel-db-manager.herokuapp.com/getauthentication

Get all data

```
curl -X GET -H "Authorization: Bearer <your_key>" https://xcel-db-manager.herokuapp.com/getalldata
```

Upload excel file curl -X POST -H "Authorization: Bearer <your_key>" -F "file=@<path_to_file>" https://xcel-db-manager.herokuapp.com/uploadexcel

🚀 Deployment

This API is not currently not available for public contributions.

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements

  • Easy excel file manipulation for businesses.
  • Inspiration
  • References

About

File manipulations in nodejs SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published