@uf-onbrand/onbrand-project-generator

The Onbrand Project Generator

1. What is this, and what is it for?

This package is a node program under the Uberflip OnBrand (@uf-onbrand) organization meant for building project files based off of templates you provide it. In the current version, the templates included are various iterations of onbrand frameworks, the purpose of which is to add custom functionality to Uberflip hubs. The webpack framework is the most recent, and most stable version.

2. How does it work?

The program is meant to be installed globally, and will give you access to the command generate once it has been installed. Calling generate from you terminal will kick off the process of building your project files in the directory you were in when you called generate. You will be prompted to name your project, and choose a template to build from, after which the files will be copied for you. Once this process is complete, the program will attempt to connect to the onbrand gitlab and set up a new repo, and you will be prompted for a user name and password. If this is successful, you will then be given the url from which you may clone the project. If this fails, you will still have your project files but they will have no corosponding repo. This tool was made to be used by the Uberflip OnBrand team, and as such, it is expecting to exist on one of their servers.

Note: You will need an enviroment variable of GITLABTOKEN and one of GITLAB_USER in order to connect to gitlab. _Note: The program will not let you continue if you do not have the latest version. Note: The templates will automatically pull from their remote in order to stay up to date.

Basic usage

Install: npm install -g @uf-onbrand/onbrand-project-generator

Run: generate

When prompted with

? Add a partner to this repository?: (Use arrow keys)
❯ Uberflip Only
  brainrider
  Relationship One
  Galaxy

select the team this repo must be accessible to. The group that is selected will have read and write access, as well as the rest of uberflip-employees.

When prompted with

? What is this repo going to be used for? (Use arrow keys)
❯ Testing only
  A customer's hub

select whether the repo will be used for testing (new employee's test hubs, generator tests, etc.) or whether it will be used for actual client work. This will add a topic of test or cihost to the project.

Then enter the repo name and bingo! you've got a brand new project ready to go! 🥳

Happy OnBranding!

Configure

You may optionally include an environment variable TEMPLATES which contains a string of git repos seperated by spaces. These will become the templates used by the generator. If these are not included, it will fallback to the hardcoded values.

Updating the deploy path:

• Please run generate --deploy-to <someFolderNameHere>
• You may also use the alias "-d"