Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
D4isDAVID committed Sep 9, 2024
0 parents commit 16fa99f
Show file tree
Hide file tree
Showing 25 changed files with 1,211 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{lua,html,css,js,ts}]
indent_size = 4
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @D4isDAVID
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[D4's FiveM Hub Discord server](https://discord.gg/rdjpS2K8hC).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: D4isDAVID
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Bug Report
description: Create a report for broken functionality
labels: bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a bug report!
Please use the Discord server to ask questions and receive support: https://discord.gg/rdjpS2K8hC
- type: input
id: summary
attributes:
label: Summary
description: Write a short and concise description of your bug.
validations:
required: true
- type: textarea
id: repro
attributes:
label: Reproduction
description: What did you do to make this happen?
placeholder: |
1. Using ...
2. Do ...
3. Then use ...
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
description: What actually happened?
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: If you have any other context about the problem such as screenshots or videos, add them here.
- type: input
id: version
attributes:
label: Current Version
description: What version of the resource are you currently using? (you can find it inside the `fxmanifest.lua` file)
placeholder: e.g. v2.0.0
validations:
required: true
- type: input
id: build
attributes:
label: FXServer Build
description: Which FXServer build are you using? (use the console `version` command to find out)
placeholder: e.g. FXServer-master SERVER v1.0.0.7290 win32
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Support Server
url: https://discord.gg/rdjpS2K8hC
about: Ask questions, receive support, and discuss with the community in D4's FiveM Hub.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request
description: Suggest new functionality or improvements
labels: enhancement
body:
- type: markdown
attributes:
value: |
Please use the Discord server to ask questions and receive support: https://discord.gg/rdjpS2K8hC
- type: textarea
id: problem
attributes:
label: The problem
description: A clear and concise description of what the problem is, or what feature you want to be implemented.
placeholder: |
Some examples:
I'm frustrated that ...
It would be nice if ...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Ideal solution
description: A clear and concise description of what you want to happen, with as much detail as possible.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative solutions
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional
attributes:
label: Additional context
description: If you have any other context about the problem such as screenshots or videos, add them here.
91 changes: 91 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Build

on:
pull_request:
push:
branches:
- '**' # every branch
- '!nobuild-**' # unless marked as nobuild
tags:
- '**'

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
sparse-checkout: |
server
CHANGELOG.md
LICENSE
README.md
base.tsconfig.json
build.js
discordbot.cfg
fxmanifest.lua
package-lock.json
package.json
sparse-checkout-cone-mode: false

- name: Setup Node.js v22
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm

- name: Install dependencies
run: npm ci
- name: Build
run: npm run build

- name: Post-build
shell: bash
run: |
rm -rf "./.git"
rm -rf "./node_modules"
rm -rf "./server"
rm -rf "./.yarn.installed"
rm -rf "./base.tsconfig.json"
rm -rf "./build.js"
rm -rf "./package-lock.json"
rm -rf "./package.json"
mkdir ../discordbot-out
mv -v * ../discordbot-out/
mv -v ../discordbot-out/ ./discordbot/
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: discordbot
path: |
./*
publish:
name: Publish
runs-on: ubuntu-latest
needs: build
if: ${{ github.event_name == 'push' && github.ref_type == 'tag' }}
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Download artifact
uses: actions/download-artifact@v4

- name: Archive
shell: bash
run: |
7z a "discordbot.zip" "./discordbot/discordbot"
- name: Draft release
uses: softprops/action-gh-release@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
draft: true
files: |
./*.zip
36 changes: 36 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Test

on: [pull_request, push]

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js v22
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- name: Install dependencies
run: npm ci
- name: Lint
run: npm run lint

typecheck:
name: Typecheck
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js v22
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- name: Install dependencies
run: npm ci
- name: Typecheck
run: npm run typecheck
Loading

0 comments on commit 16fa99f

Please sign in to comment.