Java Seed

This project is intended as a demo for young developers trying to learn how to structure Java projects for their development courses. It is intended to eventually turn this into a template they can create their own repos from to start without figuring out all of the machinery first.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: ocrosby, java-seed, twitter_handle, omarcrosby, email_client, email, project_title, project_description

(back to top)

Built With

• 
• [][React-url]
• [![Vue][Vue.js]][Vue-url]
• [![Angular][Angular.io]][Angular-url]
• [![Svelte][Svelte.dev]][Svelte-url]
• [![Laravel][Laravel.com]][Laravel-url]
• [![Bootstrap][Bootstrap.com]][Bootstrap-url]
• [![JQuery][JQuery.com]][JQuery-url]

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Install the Java SE Development Kit

2. Install Apache Maven

3. Setting up your project for maven

   mvn archetype:generate -DgroupId=com.acme.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

4. Clone the repo

git clone https://github.com/ocrosby/java-seed.git

5. Install with Maven

mvn -B package --file pom.xml

6. Run the program

java -cp target/java-seed-1.0-SNAPSHOT.jar com.acme.app.App

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/ocrosby/java-seed

(back to top)

References

• Building and testing Java with Maven
• Introduction to the standard directory layout
• Java Hello World

Acknowledgments

(back to top)