diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..e1a1650 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,70 @@ +## Prerequisites + +You will need the following things properly installed on your computer. + +* [Git](https://git-scm.com/) +* [Volta](https://volta.sh/) or [Node.js](https://nodejs.org/) (with `yarn`) +* [Ember CLI](https://cli.emberjs.com/release/) +* `Firefox` or `Google Chrome` (`Firefox` is better 😛) + +## Installation + +* `git clone ` this repository +* `cd meiliadmin` +* `yarn install` + +## Running / Development + +* `ember serve` +* Visit your app at [http://localhost:4200](http://localhost:4200). +* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). + +### Code Generators + +Make use of the many generators for code, try `ember help generate` for more details + +### Running Tests + +* `ember test` +* `ember test --server` + +### Linting + +* `yarn lint` +* `yarn lint:fix` + +### Building + +* `ember build` (development) +* `ember build --environment production` (production) + +## Further Reading / Useful Links + +* [ember.js](https://emberjs.com/) +* [ember-cli](https://cli.emberjs.com/release/) +* Development Browser Extensions + * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) + * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) + +## Install dummy Meilisearch instance +```bash +# Create folder +$ mkdir data && cd data + +# Install Meilisearch +$ curl -L https://install.meilisearch.com | sh + +# Download a dataset +$ curl https://docs.meilisearch.com/meteorites.json --output meteorites.json + +# Start Meilisearch +$ ./meilisearch + +# Create a new index `meteorites` and push the dataset +$ curl -X POST 'http://localhost:7700/indexes/meteorites/documents' -H 'Content-Type: application/json' --data-binary @meteorites.json +``` + +## Start Meilisearch instance +```bash +$ cd data && ./meilisearch --master-key="MASTER_KEY" +``` diff --git a/README.md b/README.md index 8d24dea..51b4856 100644 --- a/README.md +++ b/README.md @@ -17,74 +17,3 @@ - Map view for geodata - Validation for json settings - Dark mode - -## Prerequisites - -You will need the following things properly installed on your computer. - -* [Git](https://git-scm.com/) -* [Volta](https://volta.sh/) or [Node.js](https://nodejs.org/) (with `yarn`) -* [Ember CLI](https://cli.emberjs.com/release/) -* `Firefox` or `Google Chrome` (`Firefox` is better 😛) - -## Installation - -* `git clone ` this repository -* `cd meiliadmin` -* `yarn install` - -## Running / Development - -* `ember serve` -* Visit your app at [http://localhost:4200](http://localhost:4200). -* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). - -### Code Generators - -Make use of the many generators for code, try `ember help generate` for more details - -### Running Tests - -* `ember test` -* `ember test --server` - -### Linting - -* `yarn lint` -* `yarn lint:fix` - -### Building - -* `ember build` (development) -* `ember build --environment production` (production) - -## Further Reading / Useful Links - -* [ember.js](https://emberjs.com/) -* [ember-cli](https://cli.emberjs.com/release/) -* Development Browser Extensions - * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) - * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) - -## Install dummy Meilisearch instance -```bash -# Create folder -$ mkdir data && cd data - -# Install Meilisearch -$ curl -L https://install.meilisearch.com | sh - -# Download a dataset -$ curl https://docs.meilisearch.com/meteorites.json --output meteorites.json - -# Start Meilisearch -$ ./meilisearch - -# Create a new index `meteorites` and push the dataset -$ curl -X POST 'http://localhost:7700/indexes/meteorites/documents' -H 'Content-Type: application/json' --data-binary @meteorites.json -``` - -## Start Meilisearch instance -```bash -$ cd data && ./meilisearch --master-key="MASTER_KEY" -```