@realdecoy/frontier v0.0.2-beta.11
Frontier
Frontier, Bringing a new frontier to software engineering.
Frontier brings together engineering standards across disciplines for ease of use, promoting consistent software development.
Contributions are welcome! You can help us by reporting or fixing bugs and giving us feedback on new/existing features.
Table of Contents
Usage
npx @realdecoy/frontier <namespace> <command>
namespaces are optional if running frontier commands in an existing frontier project
The help menu can be accessed with the command:
npx @realdecoy/frontier --help
The current version of frontier can be retrieved with the command:
npx @realdecoy/frontier --version
Options
Usage:
npx @realdecoy/frontier <namespace> <command>
Namespaces:
mobile - React Native Scaffolding
vue - Vue.js Scaffolding
Commands:
create-project - Scaffold a new project
add - Add a feature to a project
plugin - Inject a utility to extend project functionality
upgrade - Specify the template version for a project
Options:
--help - Show help information
--version - Show cli version
Namespaces
Name | Namespace | Alias | Status | More Information |
---|---|---|---|---|
.Net | plugin-dotnet | dotnet | Pre-Technical Proposal | Read More |
Vue | plugin-vue | vue | Ready | Read More |
QA | plugin-qa | qa | Technical Proposal | Read More |
Mobile | plugin-mobile | mobile | Technical Proposal | Read More |
Infrastructure | plugin-iac | iac | Pre-Technical Proposal | Read More |
Development
Install Dependencies
yarn install
or
npm install
Execute CLI commands
./bin/dev <namespace> <command>
e.g.
$ ./bin/dev vue create-project my-new-project
? Pick a preset: » - Use arrow-keys. Return to submit.
> Buefy & Localization (recommended)
Vuetify & Localization
[Skip presets]
Building
Build
The build command rebuilds all packages and notify the user of the success of the packages being rebuilt. To build the packages of frontier, run the command:
yarn run build
or
npm run build
Rebuild
Rebuilding the frontier packages automatically reconstructs the packages forgetting about any previous compliation of them. To rebuild the frontier packages, run the command:
yarn run rebuild
or
npm run rebuild
Testing
Run Unit Test Suite
yarn run test
or
npm run test
Creating Tests
- create a
<module-name>.test.ts
file in the respective folder - using
chai
assertion syntax, describe your unit test cases - visit the oclif testing documentation to see more details
Contribution Instructions
Testing Requirements
All code contributions made to this repository be properly tested. For testing the testing framework Jest is used. All test files must be writen with the extension ".spec.ts", to maintain the consistency of this project.
GitHub Commits
All commits maded to this repository be rewritten according to the Conventional Commit Messages Standard. This is to ensure that consistency is maintained throughout the repository.
Pull Request
When creating a pull request ensure that the request is well documented and the changes made to the repository have been properly noted. Ensure to link the issue number/s that the pull request satisfies.
4 months ago
4 months ago
9 months ago
9 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago