create-ivx-app
v1.1.4
Published
Generator to create tecronomicon compliant frontend project
Downloads
24
Maintainers
Keywords
Readme
CREATE-IVX-APP
create-ivx-app is a generator to create standard-compliant frontend project scaffolding to quickly get started.
Installation/Updating
both require the same command:
npm i -g create-ivx-app
or yarn add global create-ivx-app
remember to execute this command before every creation to make sure your installation is up-to-date.
Usage
- open your terminal and navigate to the folder you want to create your project in, i.e.
cd ~/my-projects
- start the generator:
create-ivx-app
- you will be prompted for a couple of options, fill them out as needed
- a folder with appropriate file structure will be generated. have fun!
Development
Package Manager
This generator repo does not make use of yarn, since it is publically available and restricting usage to machines that have yarn installed would be detrimental. As such, make sure you use npm for installing dependencies, as otherwise the lockfile won't be respected.
Maintenance
This project consists of two projects (a generator which e.g. copies files and a react template project itself). To maintain both you have to do the following steps:
- Check out repository
Generator project
- Install dependencies with
npm i
(IMPORTANT: do not use yarn for this!) - Update dependencies with
npm update
- Make sure tests still run with
npm run test
templates/react-app project
- Change into the subdirectory
templates/react-app
- (temporarily) remove the project name placeholder
"name": "%%{CREATE_IVX_APP_PROJECT_NAME_SLUG}%%",
frompackage.json
(we use yarn here to generate the correct lockfile). - Install dependencies with
yarn
- Update dependencies with
yarn upgrade-interactive --latest
- Revert changes of removed name placeholder in
package.json
Publish the generator to npm: Before merging the changes, publish a new package version with yarn publish