erx-manaois / teami Goto Github PK

Best-README-Template

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam quam quam, egestas id sapien sit amet, viverra luctus justo. Curabitur sed arcu vel mi mollis ultricies. Suspendisse in tortor lectus. Vestibulum consectetur enim neque, vel malesuada nulla imperdiet nec. Vivamus a egestas dolor. Maecenas et sem purus. Cras at felis sit amet justo cursus porta. Morbi luctus, purus id convallis consectetur, ex lorem lacinia libero, vel bibendum eros metus sit amet turpis. Nulla vestibulum mi in diam consectetur placerat..

(back to top)

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

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.

1. Docker and docker-compose cli

1. WSL
2. Debugger for java
3. Extension pack for java
4. Maven for java
5. Project manager for java
6. Test runner for java
7. EsLint
8. Gitlense (optional)

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone [email protected]:jcaanacio/teami.git

2. Install Java and apache maven

   There comes a time to install Java. I am using SDKMAN since a few years now, so I’ve decided to go with it this time as well. I went through installation manual (https://sdkman.io/install). This gets me into an issue. First I needed to install obvious dependency - curl and zip/unzip.

   sudo apt-get update
   sudo apt-get install curl
   sudo apt-get install zip unzip

   After that, as manual is stating I’ve invoked command

   curl -s "https://get.sdkman.io" | bash

   Lastly, run the following code snippet to ensure that installation succeeded:

   sdk version

   Now we will install Java and apache maven using SDKMAN!

   enter the command to check all java versions that we could use. this project uses JAVA 17.

   sdk install java 17.0.6-tem

   and for our maven

   sdk install maven

3. Build docker image containers (Check the docker-compose.yml for the configurations)

   docker-compose up

4. Create database schema and populate the table using the following scripts.

   • teami/scripts/create-tbl.sql
   • teami/scripts/insert.sql

(back to top)

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)

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

(back to top)

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. Create your Feature Branch (git checkout -b feature|fix/AmazingFeature)
2. Commit your Changes (git commit)

   <type>(<scope>): <short summary>
     │       │             │
     │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
     │       │
     │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
     │                          elements|forms|http|language-service|localize|platform-browser|
     │                          platform-browser-dynamic|platform-server|router|service-worker|
     │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|
     │                         devtools
     │
     └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

3. Push to the Branch (git push origin feature|fix/AmazingFeature)
4. Open a Pull Request

(back to top)

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

(back to top)

Jliner - @officialJliner - [email protected]

(back to top)

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)