Merge pull request #19 from knovator/documentation

Documentation

README.md

@@ -1 +1,170 @@
-# impler.io
+<a name="readme-top"></a>
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+
+<h3 align="center">impler.io</h3>
+
+  <p align="center">
+    Open source infrastructure for data import
+    <br />
+    <a href="https://github.com/knovator/impler.io"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/knovator/impler.io">View Demo</a>
+    ·
+    <a href="https://github.com/knovator/impler.io/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/knovator/impler.io/issues">Request Feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li><a href="#setup">Setup</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+All projects needs 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 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.
+
+> impler.io is under development.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Built With
+
+* [Nestjs](https://nestjs.com/)
+* [Typescript](https://www.typescriptlang.org/)
+* [Nx](https://nx.dev/)
+* [Pnpm](https://pnpm.io/)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Setup
+To setup `impler.io` locally, you need 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. Copy `.env.development` file from `apps/api/src` to `apps/api/src/.env` and do changes to variables if needed.
+4. Start the application, `pnpm start:dev`.
+5. Start interacting with API by visiting `http://localhost:3000/api`.
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+`impler` need to be communicated through **REST API**, you can easily makes call through **Swagger UI** provided at `http://localhost:3000/api`, 
+1. You create `project`.
+2. You add `template` to `project`, Template refers to set of data you want to import i.e. users data.
+3. Add `columns` to `template`, Column refers to individual fields template can have, for example users Template can have firstname, lastname, address, email, phonenumber, etc.
+4. Upload `file` to `template`, After columns being set well, we're ready to import `.csv`, `.xls`, `.xlsx` file to aplication.
+    * `Upload` response returns data with `headings` specified in uploaded file.
+    * Keep note of uploaded file `id`, it will be used later.
+    * Uploaded file headings will be mapped automatically with `columns` provided for `template`.
+5. Check `mapping` done for uploaded file, and finalize mappings.
+6. Get `review` data for uploaded file and confirm reivew with option whether you want ot excempt invalid data or want to keep them.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [x] API
+  - [x] Project
+  - [x] Template
+  - [x] Column
+  - [x] Upload
+  - [x] Mapping
+  - [x] Review
+  - [ ] Processing data
+- [ ] Web
+  - [ ] Upload Phase
+  - [ ] Mapping Phase
+  - [ ] Review Phase
+  - [ ] Confirm Phase
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+<!-- CONTRIBUTING -->
+## 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
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Knovator - [@knovator](https://twitter.com/knovator)
+
+Project Link: [https://github.com/knovator/impler.io](https://github.com/knovator/impler.io)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/knovator/impler.io.svg?style=for-the-badge
+[contributors-url]: https://github.com/knovator/impler.io/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/knovator/impler.io.svg?style=for-the-badge
+[forks-url]: https://github.com/knovator/impler.io/network/members
+[stars-shield]: https://img.shields.io/github/stars/knovator/impler.io.svg?style=for-the-badge
+[stars-url]: https://github.com/knovator/impler.io/stargazers
+[issues-shield]: https://img.shields.io/github/issues/knovator/impler.io.svg?style=for-the-badge
+[issues-url]: https://github.com/knovator/impler.io/issues
+[license-shield]: https://img.shields.io/github/license/knovator/impler.io.svg?style=for-the-badge
+[license-url]: https://github.com/knovator/impler.io/blob/master/LICENSE.txt