Generate new project

To get started with Web App Rocket Generator run:

yo @totalsoft/webapp-rocket

Make sure you have the latest version of Web App Rocket Generator installed or else you will be prompted the following message:

You will be prompted to introduce the following information:

  1. The project name. This will also be the name of the new folder in which the new application will live. A valid project name, only includes lower and upper case letters, digits and '-' or '_' separators! No special characters and whitespace are allowed and do not start or end with a separator!

  2. Project description. This will be visible in the browser tab and link details.

  3. GraphQL address. By default it would be set to localhost:4000

  4. Use subscription. By default is set to false. This will include the WebSocket link in ApolloClient.

  5. Application theme. There is a list of available themes you can choose from.

  6. Default helm files - by default are not included.

    • The name of your helm chart.

      Provide a valid helm chart name, only use lower case letters, digits and '-' separators! No special characters and whitespace are allowed and do not start or end with a separator!

  7. Authorization

    By default is set to false. This includes rights and permissions restriction layer. This will also generate a GET_USER_DATA query that loads the users rights. (see architecture docs)

  8. Include Multi-tenancy infrastructure - by default is false.

  9. Quick start examples

    Some end to end examples will be included in your new generated project to help you get started.

  10. Package manager

    You can choose between npm and yarn

To run the application, simply execute:

npm start

Last updated