Skip to content

Commit

Permalink
Initialize develop
Browse files Browse the repository at this point in the history
  • Loading branch information
emrul committed May 15, 2024
0 parents commit ef75730
Show file tree
Hide file tree
Showing 28 changed files with 13,083 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build

on:
push:
branches-ignore:
- 'gh-pages'
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Build # Have to run processing first so the list.json exists to be included in the the deploy
run: |
npm ci --prefix processing
node processing
npm ci --prefix site
npm run deploy --prefix site
- name: Generate App List # Have to run it again because the deploy wipes the file and folders out
run: |
npm ci --prefix processing
node processing
- name: Move to branch
if: github.ref != 'refs/heads/develop'
run: |
mv public ${{ github.head_ref || github.ref_name }}
mkdir public
mv ${{ github.head_ref || github.ref_name }} public
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: public
force: false
clean: false
48 changes: 48 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# build output
dist
public
.next
target
packages/next/wasm/@next
out
site/public/icons
site/public/list.json

# dependencies
node_modules

# logs & pids
*.log
pids
*.cpuprofile

# coverage
.nyc_output
coverage

# test output
test/**/out*
test/**/next-env.d.ts
.DS_Store
/e2e-tests
test/tmp/**

# Editors
**/.idea
**/.#*
.nvmrc

# examples
examples/**/out
examples/**/.env*.local

pr-stats.md
test-timings.json

# Vercel
.vercel
.now

# Cache
*.tsbuildinfo
.swc/
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# THIS IS CURRENTLY IN DEVELOPMENT AND NOT READY FOR PRIME TIME YET, WE'LL ANNOUNCE WHEN IT'S INCLUDED IN BUILDS. FEEL FREE TO PLAY WITH IT THOUGH AND GIVE FEEDBACK.

# Kasm Apps

This is a repository of the apps supported by Kasm. The apps list is automatically generated and can be used when creating new workspaces or using the 1 click installer

## Create your own app store

We have tried to make it as simple as possible for people to create their own app stores that work with Kasm, the easiest way to do that is to follow these steps:

1. Click on "Use this template", select Create a new repository
1. Select a Repository name, you will need to use this name later in the process as well, tick the "Include all branches" checkbox, then click on the "Create repository from template" button
1. Click on the actions tab and check whether workflows need enabling, if they do, enable them, otherwise you should be good to go.
1. Go to `/site/next.config.js` and edit the `env` section with the relevant details.
* name - The name you want to display
* description - A short description to display when a store's information button is pressed.
* icon - The image to display for your registry. You can upload an image to `/site/public/` and reference that by https://domain.com/image.png or if you aren't using a {sub}domain by referencing it from https://username.github.io/repositoryname/image.png where image.png is the name of the image you uploaded.
* listUrl - The link to the JSON. This will follow the same format as the icon above but ends in list.json, for example https://username.github.io/repositoryname/list.json
* contactUrl - A link users can use to contact you on.
If you are using a domain or a subdomain, you need to completely remove the `basePath: 'kasm-app',` line, otherwise change the value to match what you chose for the repository name in step 2.
1. Upload your apps to the /apps folder
1. Go to Settings then Pages and select Branch - gh-pages and click Save
1. Check progress in Actions
1. Once complete go back to Settings / Pages and you should have a live site. Click on the Visit Site button.
1. You should now have a working site which includes any apps you added

[![](https://cdn.loom.com/sessions/thumbnails/256fac3d2bbb422b8e779ac1c8244d33-00001.gif)](https://www.loom.com/share/256fac3d2bbb422b8e779ac1c8244d33 "")

## New schema version

If a new schema version comes out, this is what you will need to do.

1. Create a new branch with the schema version as the branch name (for example, 1.1)
1. Open `site/next.config.js` and change `env.schema` to match the version number, add the version number to the `env.listUrl` and append the version number to the `basePath` as well.

## Discovery

The tag below will hopefully make it easier for people to find your App Registry by clicking on [this github search link](https://github.com/search?q=in%3Areadme+sort%3Aupdated+-user%3Akasmtech+%22KASM-REGISTRY-DISCOVERY-IDENTIFIER%22&type=repositories). If you want to make it harder to find your repository for some reason, just remove this section.

KASM-REGISTRY-DISCOVERY-IDENTIFIER
7 changes: 7 additions & 0 deletions apps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Apps directory

This directory is for storing all the files needed for your apps store, they should be stored with the following structure:

* apps/Application Name
* apps/Application Name/app.json
* apps/Application Name/application-name.png
Loading

0 comments on commit ef75730

Please sign in to comment.