Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Create InstantSearch App v3 #10

Merged
merged 72 commits into from
Jun 5, 2018
Merged

Create InstantSearch App v3 #10

merged 72 commits into from
Jun 5, 2018

Conversation

francoischalifour
Copy link
Member

@francoischalifour francoischalifour commented May 8, 2018

This is a complete rewrite of create-instantsearch-app to add support for templates and more features to come.

Preview

Preview

Features

  • Use Inquirer for more flexible command-line interactions
  • Use npm or yarn depending on the environment
  • Install dependencies after building the app
  • Merge command arguments with options from menu
  • Options
    • Application ID
    • API key
    • Index name
    • Main searchable attribute
    • Attributes for faceting
    • InstantSearch flavor
    • InstantSearch version
    • Skip installation process
    • Support config file for app settings (--config file.json)
  • Create templates
    • InstantSearch.js
    • Vue InstantSearch
    • React InstantSearch
    • Angular InstantSearch
  • Write tests
    • Unit tests
    • End-to-end tests:
      • Make sure that directories don't get overriden, dependencies have been installed, etc.
      • Snapshot all files generated by all different command-line options to avoid regression
  • Compile templates in templates branch to import in CodeSandbox
  • Write documentation
  • Tooling
    • ESLint
    • Travis
    • Release script
    • File generation
      • Detect which extension to fill with metalsmith-replace renaming template files to .hbs. Having the original file extension allows to keep syntax highlighting and better support for IDEs. Having package.json instead of package.json.hbs could also allow Renovate to update the dependencies of the templates.

Related


I will use this branch as a new starting point for the next release with stacked PRs.

@francoischalifour francoischalifour changed the title feat(v3): Add support for templates feat(v3): Create InstantSearch App v3 May 9, 2018
@francoischalifour francoischalifour changed the title feat(v3): Create InstantSearch App v3 🚧 Create InstantSearch App v3 May 9, 2018
francoischalifour and others added 6 commits May 10, 2018 12:11
* feat: Add attributes for faceting in menu

* feat: Add attributes for faceting in IS.js template
* feat: Add new dependencies

* feat: Add `getLibraryName` function

* test: Test `getLibraryName` function

* feat: Add `fetchLibraryVersions` function

* feat: Add list to select InstantSearch version
* feat(template): Improve InstantSearch template

* feat(template): Update InstantSearch.js template

* feat(template): Add `index.css` for InstantSearch.js
* feat: Add end-to-end test script

* fix: Fix npm script to run the tests

* test(installs): Rewrite end-to-end installation tests with Jest

* feat(utils): Add `getTemplateName` util function

* feat(script): Update e2e test script

* feat(dependencies): Install `walk-sync`

* fix(e2e): Snapshot test generated files

* test(e2e): Add snapshots from file generation
@francoischalifour francoischalifour changed the base branch from develop to master June 1, 2018 09:37
@francoischalifour francoischalifour changed the title 🚧 Create InstantSearch App v3 Create InstantSearch App v3 Jun 1, 2018
@francoischalifour francoischalifour merged commit 211afef into master Jun 5, 2018
@francoischalifour francoischalifour deleted the feat/v3 branch June 5, 2018 11:04
francoischalifour added a commit that referenced this pull request Jun 5, 2018
* feat: Support InstantSearch templates (a870767)
  Closes #9
* feat: Support custom templates (#30)
* test(e2e): Test template installations (#14)
* test(e2e): Test template snapshots (9b938cc)
* ci(travis): Add Travis configuration (#22)
* docs(readme): Update documentation (#26)
* feat(release): Create templates release script (#27)
* feat(release): Create release scripts (#28)
aymeric-giraudet pushed a commit to algolia/instantsearch that referenced this pull request Dec 14, 2022
…app#10)

* feat: Support InstantSearch templates (a870767af9a409275f2a749923cc2d2e9f5fc37b)
  Closes algolia/create-instantsearch-app#9
* feat: Support custom templates (algolia/create-instantsearch-app#30)
* test(e2e): Test template installations (algolia/create-instantsearch-app#14)
* test(e2e): Test template snapshots (9b938cca54b5e583284ec4778c22a333bbf570e7)
* ci(travis): Add Travis configuration (algolia/create-instantsearch-app#22)
* docs(readme): Update documentation (algolia/create-instantsearch-app#26)
* feat(release): Create templates release script (algolia/create-instantsearch-app#27)
* feat(release): Create release scripts (algolia/create-instantsearch-app#28)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants