Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgress/scaffold-archetype
A quick start template for creating a new Scaffold project
https://github.com/kgress/scaffold-archetype
archetype java maven selenium selenium-java selenium-webdriver
Last synced: 4 months ago
JSON representation
A quick start template for creating a new Scaffold project
- Host: GitHub
- URL: https://github.com/kgress/scaffold-archetype
- Owner: kgress
- License: mit
- Created: 2019-08-08T18:37:31.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T18:26:00.000Z (4 months ago)
- Last Synced: 2024-09-27T07:42:30.952Z (4 months ago)
- Topics: archetype, java, maven, selenium, selenium-java, selenium-webdriver
- Language: Java
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Scaffold Archetype
Scaffold Archetype is a maven archetype meant for the purpose of creating new Scaffold projects quickly and easily. It uses
`maven-archetype-plugin` and `maven-resources-plugin` 3.x to build a new project's directory structure , from `archtype-metadata.xml`
in `src/main/resources/META-INF/maven`, and create all required files for a Scaffold project based on templates included
in `src/main/resources/archetype-resources`.
For additional documentation on how to run Scaffold testing or setting up additional test configurations, [visit the Scaffold repository here](https://github.com/kgress/scaffold/README.md).
# Current Version
To view the most current version, [visit the Central Repository](https://search.maven.org/search?q=g:io.github.kgress.scaffold-archetype).
# Links
- [Contributing Guide](https://github.com/kgress/scaffold-archetype/blob/master/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/kgress/scaffold-archetype/blob/master/CODE_OF_CONDUCT.md)
- [License](https://github.com/kgress/scaffold-archetype/blob/master/LICENSE.txt)
# Required Tools for Dev
* Java 11
* Maven 3.x
# CI
The build can be found [on the Github Actions page](https://github.com/kgress/scaffold-archetype/actions).
# Running the Archetype
## IDE - New Project Wizard
The best way to start a new project is to create it with an archetype in the new project wizard. Before creating the new project, make sure you have updated your maven central repository in your IDE settings. Updating will index and fetch any new entries into maven central. You'll also want to check the most recent version number of `scaffold-archetype` by visiting [the Central Repository](https://search.maven.org/search?q=g:io.github.kgress.scaffold-archetype).
IntelliJ
1. In IntelliJ, create a new project using the new project wizard
2. Select maven as the project type, java 11 as the JDK, and check the "create from archetype" checkbox
3. If you've recently updated your maven central repository in intellij, you should see the most recent version of scaffold archetype in the list of archetypes.
4. If the archetype is not in the list, follow steps 5 through 9. Otherwise, skip to 10.
5. Click the "add archetype" button
6. Enter the groupId of `io.github.kgress.scaffold-archetype`
7. Enter the artifactId of `scaffold-archetype`
8. Enter the current version of `scaffold-archetype` by checking out [the Central Repository](https://search.maven.org/search?q=g:io.github.kgress.scaffold-archetype)
9. Click okay
10. Find the newest version of `scaffold-archetype` selected from the archetype list, and create the new project with it selected
11. Follow the instructions of the new project wizard and the new project will be created with the archetype!
## Local - Archetype:Generate
If, for whatever reason, the new project wizard does not work, invoking the archetype manually is the next best option.
1. Clone the repo `git clone [email protected]:kgress/scaffold-archetype.git` in a directory where you would like the scaffold-archetype to be
2. Switch directory to `scaffold-archetype` and run a `mvn install`
3. Switch directory back to where you would like to create the new project with the archetype. A new folder will automatically be created for you based on the artifact name provided to the archetype generator.
4. Run the following command: `mvn archetype:generate -DarchetypeGroupId=io.github.kgress.scaffold-archetype -DarchetypeArtifactId=scaffold-archetype -DarchetypeVersion=DEV`
5. Follow the prompts for entering your groupId and artifactId (along with version and package if you want something different than the defaults)
6. The archetype will generate the new project for you.