Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🐛 Bug report
about: Report a problem or unexpected behavior
title: "[BUG] "
title: '[BUG] '
labels: ['bug']
assignees: []
---
Expand All @@ -11,6 +11,7 @@ A clear and concise description of what the bug is.

**How to reproduce**
Steps to reproduce the behavior (e.g.,):

1. Go to '...'
2. Click on '...'
3. Observe that '...' occurs
Expand All @@ -21,10 +22,11 @@ A clear and concise description of what you expected to happen.
**Screenshots or logs (if applicable)**
If applicable, add screenshots or copy/paste logs to help explain your problem.

**Environment (if relevant)**
- OS / Platform: [e.g. Windows 10, Ubuntu 20.04, macOS 11]
- Version (if applicable): [e.g. 1.2.3]
**Environment (if relevant)**

- OS / Platform: [e.g. Windows 10, Ubuntu 20.04, macOS 11]
- Version (if applicable): [e.g. 1.2.3]
- Additional info: [e.g. browser, plugin version, external dependency versions]

**Additional context**
Add any other context about the problem here.
Add any other context about the problem here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
blank_issues_enabled: false
blank_issues_enabled: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: ✨ Feature request
about: Suggest a new feature or enhancement
title: "[FEATURE] "
title: '[FEATURE] '
labels: ['enhancement']
assignees: []
---
Expand Down
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/task_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: ✅ Task / chore
about: A general task or chore (e.g., “update docs,” “refactor code”)
title: "[TASK] "
title: '[TASK] '
labels: ['task']
assignees: []
---
Expand All @@ -12,9 +12,10 @@ What needs to be done? Briefly describe the scope of the work.
**Why is this task needed?**
Explain why it’s important (e.g., “fixes a bug,” “improves performance,” “updates documentation”).

**Acceptance criteria**
- [ ] Criterion 1
- [ ] Criterion 2
**Acceptance criteria**

- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3 (if any)

**Additional notes**
Expand Down
14 changes: 7 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
## Summary
<!-- Provide a brief description of what this PR does -->


## Changes Made
<!-- List the main changes in this pull request -->
-
-
-

-
-
-

## Additional Information
<!-- Any other relevant information, screenshots, or context -->


## Author Information

**Discord Username:** <!-- Your Discord username (if different from GitHub) -->
**VATSIM CID:** <!-- Your VATSIM Controller ID -->

---

### Checklist:

* [ ] Have you followed the guidelines in our Contributing document?
* [ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
- [ ] Have you followed the guidelines in our Contributing document?
- [ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
18 changes: 9 additions & 9 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
open-pull-requests-limit: 5
- package-ecosystem: "cargo"
directory: "/"
- package-ecosystem: 'cargo'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
open-pull-requests-limit: 5
- package-ecosystem: "nuget"
directory: "/"
- package-ecosystem: 'nuget'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
open-pull-requests-limit: 5
22 changes: 11 additions & 11 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
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,
- 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
- 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
- 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,
- 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
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -129,4 +129,4 @@ For answers to common questions about this code of conduct, see the FAQ at
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
[translations]: https://www.contributor-covenant.org/translations
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Thank you for your interest in contributing to BARS Core! This guide will help y

cd Core
```

<br>

2. **Install Dependencies**
Expand All @@ -37,19 +38,16 @@ Thank you for your interest in contributing to BARS Core! This guide will help y
**Set up Cloudflare configuration:**

The `wrangler.toml` file is already configured and safe to use as-is. For local testing, you'll need to:

1. Create your own D1 SQL database in the [Cloudflare Dashboard](https://dash.cloudflare.com) (Storage & Databases > D1 SQL)

<br>

2. Edit `wrangler.toml` and update the database configuration (see comments in the file):
- `account_id`: Your Cloudflare account ID (found in dash.cloudflare.com/your-id/home)
- `VATSIM_CLIENT_ID`: Your VATSIM Connect application client ID
- `database_name`: Your D1 database name (e.g., "bars-dev")
- `database_id`: Your D1 database ID (found in your database page)

<br>

3. Update `package.json` scripts to use your database name:
- Replace `bars-db` with your database name in the `update-db-local` and `update-db` scripts
- Example: `"update-db": "wrangler d1 execute bars-dev-example --remote --file schema.sql",`
Expand All @@ -72,7 +70,6 @@ Thank you for your interest in contributing to BARS Core! This guide will help y
<br>

Edit `.dev.vars` and add your API credentials:

- `VATSIM_CLIENT_SECRET`: Your VATSIM Connect application secret
- `AIRPORTDB_API_KEY`: Your [AirportDB](https://airportdb.io/) API key (optional for basic testing)

Expand Down
61 changes: 34 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
<img width="180" height="180" align="left" style="float: left; margin: 0 20px 0 0;" alt="BARS Logo" src="https://avatars.githubusercontent.com/u/214760188?s=200&u=9cbb686fd7b3aa1517ecb66825da5aa0e974954e&v=4" />

<br>

**stopbars/Core**

[![Github Issues](https://img.shields.io/github/issues/stopbars/Core)](https://github.com/stopbars/Core/issues)
[![Deploy Core](https://github.com/stopbars/Core/actions/workflows/deploy.yml/badge.svg)](https://github.com/stopbars/Core/actions/workflows/deploy.yml)
![GitHub License](https://img.shields.io/github/license/stopbars/Core)
[![Discord](https://img.shields.io/discord/1323993176318414889.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://stopbars.com/discord)


Core is the foundational backend infrastructure that powers BARS. This service provides comprehensive APIs, backend systems, and real-time capabilities for all BARS services & applications across the product suite.

<br>
<p align="center">
<p align="center">
<img width="150" height="150" src="https://stopbars.com/favicon.png" alt="Logo">
</p>
<h1 align="center"><b>stopbars/Core</b></h1>
<p align="center">
<br />
Core is the foundational backend infrastructure powering all BARS services, providing comprehensive APIs for VATSIM authentication, real-time WebSocket connections for airport lighting state, airport data & point management, community contributions, division management, advanced staff operations, file storage, release management, content management, and system health monitoring.
<br />
<br />
<a href="https://stopbars.com"><strong>stopbars.com »</strong></a>
<br />
</p>
</p>

<p align="center">
<br />
<a href="https://stopbars.com/discord" target="_blank" rel="noopener noreferrer">
<img src="https://img.shields.io/badge/Discord-Join%20Server-5865F2?logo=discord&logoColor=white" alt="Discord">
</a>
<a href="https://opencollective.com/stopbars">
<img src="https://img.shields.io/static/v1?label=&message=Open%20Collective&color=297EF2&logo=opencollective&logoColor=white" />
</a>
<a href="https://www.gnu.org/licenses/agpl-3.0">
<img src="https://img.shields.io/static/v1?label=Licence&message=AGPL%20v3&color=000" />
</a>
<a href="https://github.com/stopbars/Core/actions/workflows/deploy.yml">
<img src="https://github.com/stopbars/Core/actions/workflows/deploy.yml/badge.svg" alt="Deploy Core">
</a>
<br />
</p>

## Contributing

We encourage and appreciate contributions from the community! To get started, please review our [CONTRIBUTING.md](CONTRIBUTING.md) guide, which covers the following:

- How to set up your development environment
- Code style guidelines and best practices
- Instructions for submitting pull requests
- Testing and verification procedures

Your contributions directly support the ongoing development and improvement of BARS. By getting involved, you help us build a more robust, and feature-rich product that benefits the entire flight sim community.

## Bug Reports and Feature Requests
We encourage and appreciate contributions from the community! To get started, please review our [CONTRIBUTING.md](CONTRIBUTING.md) guide, which covers how to set up your development environment, code style guidelines and best practices, instructions for submitting pull requests, and testing and verification procedures.

If you find a bug or have a feature suggestion, please submit an issue [on our GitHub repository](https://github.com/stopbars/Core/issues/new). Please follow and fill in the issue template to the best of your ability to help us address your feedback efficiently.
Your contributions directly support the ongoing development and improvement of BARS. By getting involved, you help us build a more robust, and feature-rich product that benefits the entire flight sim community. All contributors are acknowledged on our [credits page](https://stopbars.com/credits).

## Disclaimer

BARS is an **independent third-party** software project. **We are not affiliated** with, endorsed by, or connected to VATSIM, vatSys, Microsoft Flight Simulator, or any other simulation, controller client supported by our software.
BARS is an **independent third-party** software project. **We are not affiliated** with, **endorsed by**, or **connected to** VATSIM, vatSys, EuroScope, Microsoft Flight Simulator, or any other simulation, controller client supported by our software.
8 changes: 4 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

We actively maintain and apply security patches to the latest stable version of this project.

| Version | Supported |
|---------|--------------------|
| Latest | ✅ Yes |
| Older | ❌ No |
| Version | Supported |
| ------- | --------- |
| Latest | ✅ Yes |
| Older | ❌ No |

## Reporting a Vulnerability

Expand Down
Loading