createstructure.github.io

This repo is made to make it easier to contain all the documentation of the createstructure project.

createstructure

Description

BMC createstructure

Subscription to the service

Go to the subscription page
Go to the end of the page
From the left menu, select the plan you want to subscribe to
Press the “Subscribe” button, the text can be different depending on the plan
If the plan it’s not free, you will be asked to enter your credit card details
Press the “Complete” button, the text can be different depending on the plan
Now you can use the service

How to change the subscription

Go to the subscription page
Press the “Edit your plan” button and select your username
In the plan box select the plan you want to subscribe to
If the plan it’s not free, you will be asked to enter your credit card details
Press the “Complete” button, the text can be different depending on the plan
Now you can use the service with the new plan

How to unsubscribe from the service

Go to the subscription page
Press the “Edit your plan” button and select your username
In the plan box select press the “Cancel this plan” link
In the alert box, press the “OK” button
Now you are unsubscribed from the service

How to use

To use the createstructure service, you need to be subscribed to the createstructure service.

Mobile app

Use the mobile app is the easiest way to use the createstructure service. At the moment it’s disponible for Android (>= 8).

The steps to install the app are:

Download the app
Follow the tutorial on the app

The steps to upgrade the app are:

Go to Playstore
Update the app

The steps to uninstall the app are:

Go to Playstore
Uninstall the app

Ubuntu/ Debian app

The Ubuntu/ Debian app is a tool to use the createstructure service on the command line.

The steps to install the app are:

Ubuntu

sudo add-apt-repository ppa:castellanidavide/createstructure
sudo apt-get update
sudo apt-get install createstructure

Debian
- Download the last .deb file from the Release page
- sudo apt-get install <filename>.deb

The steps to update the app are:

Ubuntu
- sudo apt-get update
- sudo apt-get upgrade
Debian
- Download the last .deb file from the Release page
- sudo apt-get install <filename>.deb

The steps to uninstall the app are:

sudo apt-get remove createstructure

REST API

The REST API is a web service that allows you to use the createstructure service. It didn’t need to be installed on the computer to use the service.

The steps to use it are:

Create a GitHub token with the scope repo, workflow, org:admin and user
Follow the REST API documentation

How to create your own template

With createstructure service you can also use your own template.

A personal template to be usable needs:

to be private
to end with -template

How to create your own template:

Create a private repository with the name endind with -template (for this step you can use the createstructure service)
Costumize the repo with your own content
Create a .createstructure/change.json like this:

{
  "This is the default template.": "soldescrsol",
  "createstructure/default-template": "solnamesol",
  "default-template": "solnamesol",
  "default": "solnamesol",
  "key": "value"
}

There are some special keys whict starts and ends with sol, the list is this

Push the repository
Try the created template

How to contribute

Use the service

The fist way to contribute is to use the service. If you discover any problem, please report it to the Issues or in the Discussions pages.

If you like this project you can also tell others about it, so the community can grow :smile:.

Contributing to the code

One way to contribute to help us improve the code. In every repository, there are the instructions to rebuild the code by your own.

So the steps to contribute to the code are:

Privacy policy

Press the image below to see the privacy policy.

Repos structure

app-createstructure

Mobile app to use createstructure service createstructure/app-createstructure

debian-createstructure

Debian client app createstructure/debian-createstructure

rest-createstructure

This repository contains the REST API created for the createstructure service.

To get more info about how it works and how can you can contribute, please go to the wiki. createstructure/rest-createstructure