Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/favourdaniel/java_boiler_plate
https://github.com/favourdaniel/java_boiler_plate
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/favourdaniel/java_boiler_plate
- Owner: FavourDaniel
- Created: 2024-07-18T17:05:25.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-20T00:02:24.000Z (4 months ago)
- Last Synced: 2024-07-20T03:21:33.392Z (4 months ago)
- Language: Java
- Size: 44.9 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [App Name] Integration Guide
## Overview
[Description]
## Folder Structure
```
|--- .mvn
|--- src
| |--- main
| |--- java
| |---hng_java_boilerplate
| |---
| |---Program.java
| |---utils
| |--- resources
| |--- static
| |--- templates
| |--- application.properties
| |--- test
| |--- java
| |---hng_java_boilerplate
| |---
|--- .gitignore
|--- mvnw
|--- mvnw.cmd
|--- README.md
```
## Getting started
Ensure you have your computer setup correctly for development by installing the following
- Java 17 or higher
- Install Java SDK/JDK
- Use your favourite IDE or Text editor
## Contribution Guide
#### If you don't have git on your machine, [install it](https://docs.github.com/en/get-started/quickstart/set-up-git).
## Fork this repository
Fork this repository by clicking on the fork button on the top of this page.
This will create a copy of this repository in your account.
## Clone the repository
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
Open a terminal and run the following git command:
```bash
git clone "url you just copied"
```
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
For example:
```bash
git clone [email protected]:this-is-you/hng_project.git
```
where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
## Create a branch
Change to the repository directory on your computer (if you are not already there):
```bash
cd hng_project
```
Now create a branch using the `git switch` command:
```bash
git switch -c your-new-branch-name
```
For example:
```bash
git switch -c add-alonzo-church
```
### Make Changes
Make your changes to the codebase. Ensure your code follows the project's coding standards and guidelines.
### Run Tests
Run the existing tests to ensure your changes do not break anything. If you added new functionality, write corresponding tests and run them.
## commit those changes
Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
If you go to the project directory and execute the command `git status`, you'll see there are changes.
Add those changes to the branch you just created using the `git add` command:
## Push changes to GitHub
Push your changes using the command `git push`:
```bash
git push -u origin your-branch-name
```
replacing `your-branch-name` with the name of the branch you created earlier.
If you get any errors while pushing, click here:
- ### Authentication Error
remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
fatal: Authentication failed for 'https://github.com//first-contributions.git/'
Go to [GitHub's tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) on generating and configuring an SSH key to your account.
## Submit your changes for review into Staging
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
Now submit the pull request.
Soon your changes will be merged into the staging branch of this project. You will get a notification email once the changes have been merged.
## Setup Instructions
### 1. Clone the Repository
First, clone the repository to your local machine using Git.
```sh
git clone https://github.com/your-username/[app-name].git
cd [app-name]
```
### 2. Install Dependencies
Opening the project in your dev environemnt should automatically restore all your dependencies.
You can also install dependencies by running the following `mavin` command in your root folder.
```sh
mvn dependency:resolve
```
### 3. Run the Development Server
Press `F5` on your keyboard to run the application in debug mode for your Vscode or use whatever your IDE requires (You may need to open a .java file to trigger this).
### 4. Verify the Setup
Depending on the IDE/code editor, you should be greeted with a Hello world text when you navigate to `localhost:8080`.