generator-jhipster-svelte

Svelte Hipster

Generate cybernetically enhanced JHipster web applications

:construction: Under active development

:heart: :heart:

Introduction

This is a JHipster blueprint, that intends to use Sapper / Svelte as the client side development framework.

Prerequisites

This guide assumes that you have already setup JHipster on your workstation.

Installation

To install the blueprint, run below command:

npm install -g generator-jhipster-svelte

To update the blueprint, run below command:

npm update -g generator-jhipster-svelte

Usage

To use the blueprint, run the below command:

jhipster --blueprints svelte

Docker development

Early adopters

To develop against the latest code, follow below steps:

• Clone the repository and build the docker image:

git clone https://github.com/jhipster/generator-jhipster-svelte.git
cd generator-jhipster-svelte

docker build -t jhipster/svelte-hipster:latest .

• Create a new directory for your application and run the below command to generate the application:

mkdir svelte-app && cd svelte-app

docker run -it --rm -v $PWD:/app jhipster/svelte-hipster

• You can also run the generated application from within the container. Following examples consider maven as the build tool:

  • To run unit test cases, use the command:

  docker run -it --rm -v $PWD:/app -v ~/.m2:/home/jhipster/.m2 --entrypoint ./mvnw jhipster/svelte-hipster clean test
  

  • To start the application using the default dev profile, use the command:

  docker run -it --rm -v $PWD:/app -v ~/.m2:/home/jhipster/.m2 -p 8080:8080 --entrypoint ./mvnw jhipster/svelte-hipster -DskipTests
  

  Access application with http://localhost:8080/

• If you would like to access the container file system, you can also attach a bourne shell:

docker run -it --rm -v $PWD:/app -v ~/.m2:/home/jhipster/.m2 --entrypoint sh jhipster/svelte-hipster

:hammer_and_wrench: Development

To setup your development environment, follow below steps:

1. Link svelte blueprint globally:

cd generator-jhipster-svelte
npm link

1. Link a development version of JHipster to your blueprint (optional: required only if you want to use a non-released JHipster version, like the main branch or your own custom fork)

cd generator-jhipster
npm link

cd generator-jhipster-svelte
npm link generator-jhipster

1. Create a new directory for your application and link JHipster and svelte blueprint.

mkdir my-app && cd my-app

npm link generator-jhipster-svelte
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster --blueprints svelte

License

Apache-2.0 © Vishal Mahajan