Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.73 KB
Raw

TableclothBlank

Project template aimed at creating an external API with the ability to publish to a maven repository. It is useful for people with basic understanding of java, gradle, workflow and is designed for lazy people

License Discord

Versioning

We use Semantic Versioning 2.0.0 to manage our releases.

Features

  • Automatic compression
  • Easy to use
  • Automatic publishing to Nexus repo
  • Ability to inject dependencies
  • Documented

How To

  • Fork this project
  • Allow github-actions on your fork
  • Open settings.gradle.kts and configure project name
  • Open build.gradle.kts and follow todos
  • Open ./github/workflows/publish.yml and follow todos or delete this workflow
  • Rename project package and main class
  • Change LICENSE if you need
  • Modify the README to suit your needs so that it describes your project well. You can use shields.io
  • Create separate branches for your drafts, and push from to the development branch only if you're confident in your drafts
  • Use the development branch as the branch where your drafts are built
  • Push the development branch to the production branch only if you are sure about the stability of the first
  • Start work