diff --git a/README.md b/README.md index 8f933e1..9182a09 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ # Product Import -Import base product information from a CSV into Moltin. -## Setup and run +> A simple importer that takes product data from a CSV and imports into the Moltin API. + +📚 [moltin.com](https://moltin.com) + +## 💾 Requirements + + - Redis + - yarn + - Node (Do not use node version 10.7.0) + - Kue (https://github.com/Automattic/kue) + - Serverless (https://www.npmjs.com/package/serverless) + +## ⛽️ Usage 1. Add your product CSV to the root of this repository 2. In map.js, for each value, replace each instance of `X` with the field name in the CSV that will be mapped to the given field in moltin. @@ -22,14 +33,31 @@ Import base product information from a CSV into Moltin. 10. Run the `sls invoke local -f processInsert` function only. -> You may want to run Kue's dashboard, in which case you can call: -> -> `node_modules/kue/bin/kue-dashboard -p 3050 -r redis://127.0.0.1:6379` -> -> from the root of the repository. +## 📣 Additional + +### Kue Dashboard + +You may want to run Kue's dashboard, in which case you can call: + +```node_modules/kue/bin/kue-dashboard -p 3050 -r redis://127.0.0.1:6379``` + +from the root of the repository. + +### Clearing Redis before starting a job + +You may also want to clear out `redis` before starting a new job, in which case access `redis-cli` and call `FLUSHALL` + +## 🚫 Caveats + +Do not run `get`, `update`, and `insert` at once, as this will hit the rate limit on moltin quickly. + +**Do not use node version 10.7.0** -> You may want to clear out `redis` before starting a new job, in which case access `redis-cli` and call `FLUSHALL` +## ❤️ Contributing -> Do not run `get`, `update`, and `insert` at once, as this will hit the rate limit quickly. +We love community contributions. Here's a quick guide if you want to submit a pull request: -> Do not use node version 10.7.0 +1. Fork the repository +2. Add a tests if possible +3. Commit your changes (see note below) +4. Submit your PR with a brief description explaining your changes \ No newline at end of file