Often times uploaded spreadsheets in projects are too large to handle at once by backend applications. And to handle large quantity of imported data we need to write same solutions again and again to convert XML-to-JSON, validating data and processing that large data in chunks.

data-import is built with a intention to reduce repetitions of conversion, validation and importing data. It manages data in format of projects, templates and columns.

(back to top)

• @knovator/api
• axios
• express
• mongoose
• multer
• nodemailer
• passport
• winston
• xlsx

(back to top)

data-import is built to run as standalone application.

data-import uses MongoDB database and RabbitMQ Queue to process imported data. So you need to have MongoDB and RabbitMQ URLS ready

1. Clone the repo, and go into it

   git clone https://github.com/knovator/data-import.git
   cd data-import

2. Install NPM packages and install esm package

   yarn install

3. Copy .env.example file to .env

   cp .env.example .env

4. Edit your credentials in .env like MongoDB and RabbitMQ URLs.
5. Start the application

   yarn start

(back to top)

data-import provides set of Routes to Work with.

User Routes deals with User schema listed in user-schema.

Project Routes deals with Project schema listed in data-formats.md#project-schema.

Templates Routes deals with Templates schema listed in data-formats.md#template-schema.

Columns Routes deals with Column schema listed in data-formats.md#column-schema.

1. Create Project

HTTP POST /v1/projects
  -d '{ 'nm': '...', 'cd': '...', 'cbUrl': '...' }'

2. Add Template

HTTP POST /v1/templates
  -d '{ 'nm': '...', 'cd': '...', 'cb':{ 'm': '...', 'u': '...' }, 'p':{ 'cd': '...', 'id': '...', 'nm': '...' } }'

3. Add Columns to Template

HTTP POST /v1/projects
  -d '{ 'tId': '...', 'nm': '...', 'k': '...', 'aK': '...', 'r': false, 'u': false, 'typ': '...', 'rgx': '...', 's': '...', 't': '...', 'seq': 15 }'

4. Process File

HTTP POST /v1/templates/:templateId/process-file
  -d [file array as `files` (Max 2)]

5. Map Data

HTTP POST /v1/templates/:templateId/map-data
  -d [Response `payload` from "Step 4"]

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Knovator Technologies

• Twitter @knovator
• Web https://knovator.com/

Project Link: https://github.com/knovator/data-import

(back to top)