Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onify/helix-app-boilerplate
Boilerplate for Helix App - Build your own custom Helix App
https://github.com/onify/helix-app-boilerplate
boilerplate helix helix-app onify onify-helix
Last synced: about 5 hours ago
JSON representation
Boilerplate for Helix App - Build your own custom Helix App
- Host: GitHub
- URL: https://github.com/onify/helix-app-boilerplate
- Owner: onify
- License: mit
- Created: 2023-05-24T11:42:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-12T13:29:23.000Z (11 months ago)
- Last Synced: 2023-12-12T14:36:53.457Z (11 months ago)
- Topics: boilerplate, helix, helix-app, onify, onify-helix
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Onify Helix App - Boilerplate
This repository is your starting point for building a custom app with Onify Helix. It includes basic boilerplate code to help you get started quickly. After setting up, you'll find more information and documentation within the repository to guide you through developing your first Onify Helix custom app.
## How does it work?
This repo is used to get started with Onify Helix and create your own custom Helix App (Git) repo.
1. Make sure you have access to the Helix repo (see Prepare section)
2. Create your own Helix App Git repo (see Setup section)
3. Configure your new Helix App repo (check new README for more info)
1. Create `.npmrc` containing your GitHub personal access token
2. Run `npm i`
3. Set environment variables (in `.env`)
4. Start developing (run `npm run dev`)
5. Deploy
## Prepare
To get started, you first need access to the Onify Helix private repo (https://github.com/onify/helix). Please contact Onify support (`[email protected]`) to get you personal access token (use later as ``).
## Setup
To download and setup the `helix-app` repo onto your machine, run the command:
> IMPORTANT: Make sure you are in the correct folder files will be overwritten. Even this README :-)
### Download stable version
To download last stable version, first go to supportsite and check [changelog](https://support.onify.co/changelog). Get the latest version, eg. `0.30.0` and then run the following command:
```bash
npx giget "gh:onify/helix/apps/helix-app#v0.30.0" ./ --auth="" --force --verbose
```
### Download latest
To download the latest (nightly build), run the following command:
```bash
npx giget "gh:onify/helix/apps/helix-app" ./ --auth="" --force --verbose
```
## Get started with Onify Blueprints
To get started with Helix, please checkout our [Onify Blueprints](https://github.com/search?q=topic%3Aonify-blueprints+topic%3Ahelix+&type=repositories)