Skip to content

Commit 25bd7d8

Browse files
harshkhandeparkarharshkhandeparkar
authored
Initial commit
0 parents  commit 25bd7d8

File tree

11 files changed

+1189
-0
lines changed

11 files changed

+1189
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
https://bit.ly/metakgp-slack.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- CONTRIBUTING -->
2+
## Contributing
3+
4+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
5+
6+
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".
7+
Don't forget to give the project a star! Thanks again!
8+
9+
1. Fork the Project
10+
2. Create your Feature Branch (`git checkout -b feature`)
11+
3. Commit your Changes (`git commit -m 'Add some newFeature'`)
12+
4. Push to the Branch (`git push origin feature`)
13+
5. Open a Pull Request

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug/unintended behavior is.
12+
13+
**Expected behavior**
14+
A clear and concise description of what you expected to happen.
15+
16+
**Screenshots**
17+
If applicable, add screenshots to help explain your problem.

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**The Problem**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Possible solutions**
14+
A clear and concise description of what you want to happen.

‎.github/SECURITY.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you have discovered a vulnerability within the project, we sincerely appreciate your efforts in helping us maintain a secure system. We take security concerns seriously and encourage you to report any potential vulnerabilities promptly. This section will guide you on how to report a vulnerability and what you can expect during the process.
6+
7+
### Reporting Process
8+
9+
To report a vulnerability, please follow these steps:
10+
11+
1. **Create an Issue**: Go to the project's GitHub repository and create a new issue. Please provide a clear and concise title that reflects the nature of the vulnerability.
12+
13+
2. **Include Details**: In the issue description, please provide us with a detailed explanation of the vulnerability. It would be immensely helpful if you could include steps to reproduce the issue, relevant code snippets, and any additional information that can assist us in understanding and addressing the problem effectively.
14+
15+
3. **Contact Information**: Don't forget to include your contact information (preferably an email address) so that we can reach out to you for further clarification or updates regarding the reported vulnerability.
16+
17+
### Response and Update
18+
19+
Once you have reported a vulnerability, we will promptly review the issue and respond to you within a reasonable timeframe. We aim to acknowledge the report within **4 business days** and provide an initial assessment of the vulnerability's severity.
20+
21+
### Vulnerability Assessment
22+
23+
After receiving your vulnerability report, we will conduct a thorough assessment to determine its validity and severity. We may request additional information or clarifications from you during this process to ensure a comprehensive evaluation.
24+
25+
### Acceptance or Decline
26+
27+
If the vulnerability is accepted, we will take appropriate measures to address and fix the issue. We will provide you with expected timelines for resolving the vulnerability.
28+
29+
In case the vulnerability is deemed outside the scope of the project or does not pose a significant risk, it may be declined. We will provide a clear explanation for our decision and any recommended actions, if applicable.
30+
31+
### Public Disclosure
32+
33+
To ensure the safety and security of our users, we kindly request that you refrain from publicly disclosing the vulnerability until we have had sufficient time to address it. We strive to resolve vulnerabilities in a timely manner and appreciate your cooperation in maintaining responsible security practices.
34+
35+
### Recognition
36+
37+
We deeply value the contributions of the security community, and we are open to recognizing individuals who responsibly report vulnerabilities. If you would like to be credited for your discovery, please let us know when submitting the report.
38+
39+
Thank you for helping us improve the security of the project. We genuinely appreciate your support in making our software safer for everyone.

‎.github/pull_request_template.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Description
2+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
3+
4+
Fixes # (link issue here if applicable)
5+
6+
- [ ] I have updated the relevant documentation

‎.github/workflows/deploy.yaml‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
name: Continuous Deployment Pipeline
2+
3+
on:
4+
push:
5+
branches:
6+
- "main"
7+
paths-ignore:
8+
- "**.md"
9+
- "LICENSE"
10+
- "LICENSE.txt"
11+
- "frontend/**"
12+
13+
jobs:
14+
dockerhub:
15+
name: Publish Docker Image(s) to Dockerhub
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout Repository
20+
uses: actions/checkout@v4
21+
22+
- name: Set up QEMU
23+
uses: docker/setup-qemu-action@v3
24+
25+
- name: Set up Docker Buildx
26+
uses: docker/setup-buildx-action@v3
27+
28+
- name: Login to Docker Hub
29+
uses: docker/login-action@v3
30+
with:
31+
username: ${{ secrets.DOCKERHUB_USERNAME }}
32+
password: ${{ secrets.DOCKERHUB_PASSWORD }}
33+
34+
- name: Cache Docker layers SERVICE_NAME
35+
uses: actions/cache@v3
36+
with:
37+
path: /tmp/.buildx-cache-SERVICE_NAME
38+
key: ${{ runner.os }}-buildx-SERVICE_NAME-${{ github.sha }}
39+
restore-keys: |
40+
${{ runner.os }}-buildx-SERVICE_NAME-
41+
42+
- name: Build & Push SERVICE_NAME
43+
uses: docker/build-push-action@v5
44+
with:
45+
context: .
46+
push: true
47+
tags: ${{ secrets.DOCKERHUB_USERNAME }}/SERVICE_NAME:latest
48+
cache-from: type=local,src=/tmp/.buildx-cache-SERVICE_NAME
49+
cache-to: type=local,dest=/tmp/.buildx-cache-SERVICE_NAME-new,mode=max
50+
51+
- name: Move SERVICE_NAME cache
52+
run: |
53+
rm -rf /tmp/.buildx-cache-SERVICE_NAME
54+
mv /tmp/.buildx-cache-SERVICE_NAME-new /tmp/.buildx-cache-SERVICE_NAME
55+
56+
push:
57+
name: Push Code Stage
58+
needs: dockerhub
59+
runs-on: ubuntu-latest
60+
61+
steps:
62+
- name: Sync local repo with remote repo
63+
uses: appleboy/ssh-action@master
64+
env:
65+
PROJECT_DIR: ${{ secrets.PROJECT_DIR }}
66+
with:
67+
host: ${{ secrets.SSH_HOSTNAME }}
68+
username: ${{ secrets.SSH_USERNAME }}
69+
key: ${{ secrets.SSH_PRIVATE_KEY }}
70+
passphrase: ${{ secrets.SSH_PRIVATE_KEY_PASSPHRASE }}
71+
envs: PROJECT_DIR
72+
script_stop: true
73+
script: |
74+
cd "${PROJECT_DIR}/"
75+
sudo git fetch origin
76+
sudo git reset --hard origin/main
77+
78+
pull:
79+
name: Pull Image Stage
80+
needs: push
81+
runs-on: ubuntu-latest
82+
83+
steps:
84+
- name: Pull the latest images(s)
85+
uses: appleboy/ssh-action@master
86+
env:
87+
PROJECT_DIR: ${{ secrets.PROJECT_DIR }}
88+
with:
89+
host: ${{ secrets.SSH_HOSTNAME }}
90+
username: ${{ secrets.SSH_USERNAME }}
91+
key: ${{ secrets.SSH_PRIVATE_KEY }}
92+
passphrase: ${{ secrets.SSH_PRIVATE_KEY_PASSPHRASE }}
93+
envs: PROJECT_DIR
94+
script_stop: true
95+
script: |
96+
cd "${PROJECT_DIR}/"
97+
sudo docker compose pull
98+
99+
deploy:
100+
name: Deploy Stage
101+
needs: pull
102+
runs-on: ubuntu-latest
103+
104+
steps:
105+
- name: Deploy the latest build(s)
106+
uses: appleboy/ssh-action@master
107+
env:
108+
PROJECT_DIR: ${{ secrets.PROJECT_DIR }}
109+
with:
110+
host: ${{ secrets.SSH_HOSTNAME }}
111+
username: ${{ secrets.SSH_USERNAME }}
112+
key: ${{ secrets.SSH_PRIVATE_KEY }}
113+
passphrase: ${{ secrets.SSH_PRIVATE_KEY_PASSPHRASE }}
114+
envs: PROJECT_DIR
115+
script_stop: true
116+
script: |
117+
cd "${PROJECT_DIR}/"
118+
sudo docker compose down
119+
sudo docker compose up -d

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Garbage & not required config files
2+
.DS_Store
3+
.vscode
4+
node-modules/

0 commit comments

Comments
 (0)