impler.io

Open source infrastructure for data import
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Setup
3. Usage
4. Contributing
5. License
6. Contact

About The Project

All projects need to give some kind of data import facility, so that their users can import data in application through files like .csv, .xls, .xlsx, etc.

At first it looks like just importing file and inserting in database, but as the app grows facilities like validating data, data mapping, becomes must. impler provides infrastructure to applications, so that they don't have to write code for data import.

(back to top)

Built With

• Nestjs
• Typescript
• Nx
• Pnpm

(back to top)

Setup

To set up impler.io locally, you need the following things installed in your computer.

1. pnpm
2. localstack
3. mongodb

Follow these steps to setup the project locally,

1. Clone the repo, git clone https://github.com/knovator/impler.io.
2. Install the dependencies, pnpm install.
3. Do setups for projects by running, pnpm setup:project.
4. Start the application, pnpm start:dev.
5. Start interacting with API by visiting http://localhost:3000/api or see demo on http://localhost:5173.

Add Import Schema

After doing setup, you can easily make call to the impler through Swagger UI provided at http://localhost:3000/api,

1. Create project by calling /v1/project API, and Copy _id from the response.
2. Create template by calling /v1/template/{projectId} API, and Copy _id from the response.
3. Update columns for template by calling /v1/column/{templateId} API.

See Demo

If you're running impler locally, after adding-schema you can start interacting with import widget from http://localhost:5173.

(back to top)

Contributing

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)

License

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

(back to top)

Contact

Knovator - @knovator

Project Link: https://github.com/knovator/impler.io

(back to top)