OT275-server

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

ONG-java

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# README

### PROJECT SETUP

1. Download and install JDK 11.
    1. You can use [SDKMAN](https://sdkman.io/install).
    2. Verify your version using: `java --version`.
2. Download and install [Apache Maven 3.8.4](https://maven.apache.org/download.cgi).
    1. Verify your version using: `mvn --version`.
3. Install [MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html).
    1. For local purposes, you can use H2 database. If you do it, ensure you do not commit it.
4. Select the IDE that you want to use: IntelliJ, VS Code, Eclipse, etc.
    1. Based on your selection, download the `*-style.xml` file for your IDE
       from [Google Style Guide](https://github.com/google/styleguide).
    2. Set up the downloaded file in the IDE preferences.
    3. Ensure `import with '*'` option is configured as 99.
5. Download and install [Postman](https://www.postman.com/downloads/).

[ IMPORTANT ] Step 4 is a MUST if you want to open a pull request. Otherwise, your code will not
pass the check status and your code changes will not be reviewed.

[ OPTIONAL ] Sendgrid and AWS secrets MUST NOT be committed in the repository. In order to
ensure that potential secrets or sensitive information do not leave the developer's workstation,
you can use [Talisman](https://github.com/thoughtworks/talisman).

### CODE STANDARDS

We follow the rules
from [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) and:

- The interfaces should start with prefix "I". Example: IUserRepository.
- The name of abstract classes should start with prefix "Abstract". Example: "AbstractFile".
- Package names are in singular.
- The names of attributes/fields from Java classes must be written using camel case. Example:
  firstName.
- The name of columns in the entities must be written using underscore and uppercase. Example:
  FIRST_NAME.
- The name of the tables is always in plural, but the entity name should be in singular.
- Exceptions should be handled by an implementation of ControllerAdvice.
- All the configuration classes must go in the config package.
- The integration test must go into the bigtest package.
- If you add a new endpoint, make sure to set the role access for it in the SecurityConfig class.

- [ Optional ] You will find an example of how to work with the project architecture in
  `architecture-example` branch.

### KEEP IN MIND FOR PULL REQUEST AND CODE REVIEW

#### FORMAT

- The branch name format is: `{jiraTicket#}`.
- The pull request title format is: `{jiraTicket#}: {jiraTitle}`.
- The commits format is: `{jiraTicket#}: {commitDescription}`. Small commits are a nice to have.
- The pull request has to contain only the changes related to the scope defined in the ticket.
    - If you pull request contains unrelated changes, it will be rejected until those changes be
      removed.
- If your pull request does not pass all the checks, it will not be review until checks passed.

#### EVIDENCE

- If you do not write unit test or integration test as part of your code changes, you should add the
  HTTP request and response as evidence that the code is working as expected.
- Postman collection should be updated every time that you open a pull request. Be a team player!

#### REQUEST RE-REVIEW

- Once you addressed all the comments, click on "Request re-review" button.
- [ Optional ] At the bottom of the pull request, you can leave a comment asking for re-review.

### RUN LOCALLY

On the root folder run:

```
mvn spring-boot:run
```

### CHECKSTYLE

You can generate the Checkstyle report by explicitly executing below command from the command line:

```
mvn checkstyle:checkstyle
```

### LINKS

- DTO:
    - [Do NOT expose entities](https://thorben-janssen.com/dont-expose-entities-in-api/)
    - [Data-Transfer Objects (DTO)](https://dzone.com/articles/dtos)
- SOLID:
    - [SOLID principles](http://www.blackwasp.co.uk/SOLIDPrinciples.aspx)
    - [Design principles](https://www.oodesign.com/design-principles.html)
- YAGNI:
    - [You Aren't Gonna Need It](https://martinfowler.com/bliki/Yagni.html)
- Design patterns:
    - [Best practices API design](https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design)
    - [Design patterns](https://refactoring.guru/design-patterns)
    - [Java Design Patterns](https://java-design-patterns.com/)
- Clean code:
    - [Writing clean code](https://github.com/jnguyen095/clean-code/blob/master/Clean.Code.A.Handbook.of.Agile.Software.Craftsmanship.pdf)
    - [Clean architecture](https://github.com/GunterMueller/Books-3/blob/master/Clean%20Architecture%20A%20Craftsman%20Guide%20to%20Software%20Structure%20and%20Design.pdf)
- Exception handling
    - [Exception handling for REST with Spring](https://www.baeldung.com/exception-handling-for-rest-with-spring)
    - [Handling exceptions and custom exceptions](https://www.javadevjournal.com/spring/exception-handling-for-rest-with-spring/)
- JPA:
    - [Cascade types](https://www.baeldung.com/jpa-cascade-types)
    - [Eager/Lazy Loading](https://www.baeldung.com/hibernate-lazy-eager-loading)
    - [Hibernate FetchType EAGER is a code smell](https://vladmihalcea.com/eager-fetching-is-a-code-smell)
- Software testing:
    - [How to get started with software testing](https://medium.com/@netxm/how-to-get-started-with-software-testing-9fa1ce4f2a64)
    - [Introduction to Test Driven Development (TDD)](https://medium.com/hackernoon/introduction-to-test-driven-development-tdd-61a13bc92d92)
    - [Mockito tutorial](https://www.baeldung.com/mockito-series)
    - [Unit tests with Mockito](https://www.vogella.com/tutorials/Mockito/article.html)
    - [jUnit5: user guide](https://junit.org/junit5/docs/current/user-guide/#overview)
    - [How do I write tests?](https://blog.devgenius.io/how-do-i-write-tests-17640185171c)
    - [How to perfect Software Design with Test Driven Development](https://www.youtube.com/watch?v=ln4WnxX-wrw&ab_channel=ContinuousDelivery)
- API documentation:
    - [OpenAPI 3 with Spring Boot](https://springdoc.org/)
    - [Async API](https://www.asyncapi.com/)
- Agile:
    - [How do you measure value?](https://www.thoughtworks.com/insights/blog/how-do-you-measure-value)
    - [Exploring value oriented incremental delivery](https://www.thoughtworks.com/insights/blog/exploring-value-oriented-incremental-delivery)
- Pair programming:
    - [On pair programming](https://martinfowler.com/articles/on-pair-programming.html)
    - [Code with me](https://www.jetbrains.com/help/idea/code-with-me.html)

### USERS

| First Name    | Last Name     | Email                | Password   | Role  |
|---------------|---------------|----------------------|------------|-------|
| John Von      | Neumann       | johnvon@neumann.com  | abcd1234   | ADMIN |
| Alan          | Turing        | alan@turing.com      | abcd1234   | ADMIN |
| Linus         | Torvalds      | sudo@torvalds.com    | abcd1234   | ADMIN |
| Stephen       | Hawking       | stephen@hawking.com  | abcd1234   | ADMIN |
| Richard       | Stallman      | richard@stallman.com | abcd1234   | ADMIN |
| ------------- | ------------- | -------------------- | ---------- | ----- |
| Robert        | Martin        | uncle@bob.com        | abcd1234   | USER  |
| Martin        | Fowler        | fowler@martin.com    | abcd1234   | USER  |
| Kent          | Beck          | kent@beck.com        | abcd1234   | USER  |
| Edsger        | Dijkstra      | edsger@dijkstra.com  | abcd1234   | USER  |
| Mary          | Shaw          | mary@shaw.com        | abcd1234   | USER  |

-----------------------------------------------------------------------------

OT275-server

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README