Initial commit for resilient-core
This commit is contained in:
commit
49fc4b2983
2169 changed files with 175785 additions and 0 deletions
26
docs/README.md
Normal file
26
docs/README.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
# 📦 Project Name
|
||||
|
||||
Brief description of your project and what it does.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Features
|
||||
|
||||
- Feature 1
|
||||
- Feature 2
|
||||
- Feature 3
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Java 17+
|
||||
- Maven 3.6+
|
||||
- (Optional) Docker
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
mvn clean install
|
35
docs/faqs/How to build a PROD jar.md
Normal file
35
docs/faqs/How to build a PROD jar.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
## ❓ Frequently Asked Questions
|
||||
|
||||
### Q: How to build a PROD jar?
|
||||
|
||||
**A:** The steps for a production JAR are:
|
||||
|
||||
- Open a command line, as Administrator
|
||||
|
||||
- Build front-end (Angular)
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
- OR:Build and package JAR
|
||||
|
||||
```bash
|
||||
mvnw -Pprod clean verify
|
||||
```
|
||||
|
||||
- OR:Build and package JAR WITHOUT tests
|
||||
|
||||
```bash
|
||||
mvnw -Pprod clean verify -DskipTests -Dmaven.test.skip=true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**B:** The result is a JAR generated in : target/
|
||||
|
||||
**C:** Things to validate
|
||||
|
||||
- In target/classes a static/ must exist, after the "Build front-end (Angular)"
|
||||
- Check for BOOT-INF/classes/static dir in the generated JAR file
|
15
docs/faqs/How to make a release.md
Normal file
15
docs/faqs/How to make a release.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
## ❓ Frequently Asked Questions
|
||||
|
||||
### Q: How to make a release?
|
||||
|
||||
**A:** To make a PROD release (not SNAPSHOT)
|
||||
|
||||
- Change the version in pom.xml (usually, remove the "-SNAPSHOT" suffix)
|
||||
- Build JAR (see "How to build a PROD jar")
|
||||
- Commit changes (the change to pom.xml)
|
||||
- Make a TAG in GIT
|
||||
- Change the version in pom.xml. Increment version and add "-SNAPSHOT" suffix
|
||||
- Commit changes
|
||||
|
||||
---
|
||||
|
39
docs/faqs/faq_template.md
Normal file
39
docs/faqs/faq_template.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
## ❓ Frequently Asked Questions
|
||||
|
||||
### Q: What does this project do?
|
||||
|
||||
**A:** This project is a [brief explanation] that helps you [achieve a goal] by [key functionality].
|
||||
|
||||
---
|
||||
|
||||
### Q: How do I build the project?
|
||||
|
||||
**A:** Use Maven:
|
||||
|
||||
```bash
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
### Q: Bullets example
|
||||
|
||||
**A:** Unordered bullet:
|
||||
|
||||
- Main item
|
||||
- Sub item 1.1
|
||||
- Sub item 1.2
|
||||
- Second item
|
||||
- Sub item 2.1
|
||||
- Sub item 2.2
|
||||
|
||||
**A:** Ordered bullet:
|
||||
|
||||
- [ ] Write documentation
|
||||
- [x] Fix bug in login flow
|
||||
- [ ] Deploy to production
|
||||
|
||||
OR
|
||||
|
||||
1. First step
|
||||
2. Second step
|
||||
3. Third step
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue