Get Started with Hapify
Hapify was born out of the desire to accelerate modern development, by replacing traditionnal static boilerplates with dynamic boilerplates.
Hapify removes the need to write repeating boilerplates for extended CRUD operations for both back-end & front=end development. Focus on features instead of doing repetitive work!
- Hapify is an agnostic code generator allowing the creation of any kind of app.
- Hapify takes two inputs, relational data-models and code templates.
- Hapify does not command any paradigm or code structure. Users can define their own code templates with their preferred language.
To be more efficient, the generated code is meant to be used within a boilerplate. Therefore, boilerplates for Hapify embed compatible code templates. You can browse code boilerplates here.
Tutorial quick overview
1. Install the CLI
First step, install the CLI using NPM:
npm install -g @hapify/cli
Additionally you can check if the package is installed by running:
2. Start a new project
In this section, we will describe how to start a project from an pre-packaged boilerplate. To start a project from a legacy boilerplate, please refer to the init command.
Create a new folder for your project and go to this folder:
mkdir my-project && cd my-project
new command to get a boilerplate and initialize your project:
Choose/create the project
First, you need to choose or create a new project. This will prompt something like this:
$ hpf new ? Choose a project ❯ Create a new project ────────────── Project 1 Project 2
Select Create a new project then enter a name and a description, or select an existing project.
Choose one or more boilerplates
Once you have selected a project, you will be able to choose a public boilerplate (available in the Hapify Hub), or to enter a custom git URL.
? Choose a boilerplate Enter a Git URL ────────────── ❯ HapiJS ExpressJS Angular 7 Vue.js
Next, you can add another boilerplate:
? Choose a project New one ? Choose a boilerplate HapiJS ? Add another boilerplate? (y/N)
For example, if you choose a back-end boilerplate, you can add one or more front-end boilerplates.
If you need only one boilerplate or if you choose a full-stack boilerplate, just say
Import pre-defined models
If your project is empty, you may want to import pre-defined models from Hapify Cloud. To do so, select some use cases when this prompts:
? Choose some presets to preload in your project ◉ Membership ◯ Messaging ◯ Billing ❯◉ Listing
Press the space bar to select and then enter to validate.
After a few seconds, the boilerplate will be cloned in your current folder and you will see:
✓ Created 1 new dynamic boilerplate in ~/my-project. Run 'hpf serve' to edit.
3. Edit project models
At this stage, you have a fresh boilerplate but no data-models in your project, unless you have imported pre-defined models. In order to create or edit the models of your project, run this command to start the local GUI:
The local GUI looks like:
To learn more about model management please refer to GUI Models.
4. Generate the code
Once your models are ready, you will be able to generate the code with this command:
This will run the generator and copy the generated files into your local boilerplate. Now you can start customizing and running the generated code.
If you need to re-generate the code (because of models or templates modifications), although you have already modified the generated code, use the command
To prevent conflicts during re-generation, please read our best practice guide.
Store your models in Hapify Cloud
By default, Hapify stores your models locally, usually next to the
hapify.json file. The path is defined in this file.
If you prefer to store your models remotely, in order to share them across multiple repositories, take the following steps.
1. Connect the CLI to Hapify Cloud
The Hapify CLI interacts with Hapify Cloud for project and model storage, code generation. Therefore, you need to get an API key from Hapify Cloud to access these CLI features.
2. Register on Hapify Cloud
If you do not have an account yet, please visit hapify.io/sign-up.
Get your API key
Once you have registered, or if you already have an account, go to hapify.io/my-key and copy your API Key.
Configure the CLI
Run this command with your API key to connect the CLI to Hapify Cloud once and for all.
hpf key XXXXXXXXXXXX
Now your CLI can interact with Hapify Cloud.
3. Connect your local boilerplate to a remote project
For every boilerplate you want to connect to a remote project, run this command:
Then create or select a project.
Now the boilerplate will store and read models from Hapify Cloud.
The ID of the project is stored in