The functionality of this generator is now available in our MEAN and MERN static applications.
This repository will not be updated. The repository will be kept available in read-only mode.
-
Run the generator and choose the options:
yo ibm-web -
Select a web framework: None, Angular or React
-
Select a language: Swift, Node, Java, Go, Python-Flask or Python-Django
Frameworks are chosen using the framework option at the end of the generator. For example,
yo ibm-web --framework {None, React, AngularJS}
In the basic web project, the following files are created and stored in the public directory:
public/index.html- Basic landing page with inline CSS and encoded image assetspublic/404.html- Basic 404 error pagepublic/500.html- Basic 500 error page
It is important that the web server is registered to serve files in the public directory.
- react - to build user interfaces
- webpack - bundles your JS modules
- sass-loader
- css-loader
- style-loader
Web sources for React projects are stored in the client directory:
client/index.html- Landing page sourceclient/index.jsx- Landing page sourceclient/app/App.jsx- Component injected into landing page bodyclient/404.htmlandclient/500.html- Error page sourcesclient/default.css- minimized stylesheet with inline encoded images
Web sources for AngularJS projects are stored in the client directory:
client/index.html- Landing page sourceclient/component.html- Landing page sourceclient/app.js- Angular app initialization, config and routingclient/404.htmlandclient/500.html- Error page sourcesclient/default.css- minimized stylesheet with inline encoded images
In order to publish changes, you will need to fork the repository or branch off the master branch.
Make sure to follow the conventional commit specification before contributing. To help you with commit a commit template is provide. Run config.sh to initialize the commit template to your .git/config or use commitizen
Once you are finished with your changes, run npm test to make sure all tests pass.
Do a pull request against master, make sure the build passes. A team member will review and merge your pull request.
Once merged to master an auto generated pull request will be created against master to update the changelog. Make sure that the CHANGELOG.md and the package.json is correct before merging the pull request. After the auto generated pull request has been merged to master the version will be bumped and published to npm.