Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the develpment guide to an external file #42

Merged
merged 1 commit into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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 <repository-url>` 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"
```
71 changes: 0 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <repository-url>` 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"
```