Skip to content

Commit 801e659

Browse files
Expand README, remove unneeded extensions
1 parent 80c792d commit 801e659

2 files changed

Lines changed: 57 additions & 7 deletions

File tree

.vscode/extensions.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
{
22
"recommendations": [
3-
"ms-azuretools.vscode-docker",
4-
"formulahendry.docker-explorer",
53
"esbenp.prettier-vscode",
64
"github.vscode-github-actions",
7-
"mongodb.mongodb-vscode",
85
"pmneo.tsimporter",
96
"austenc.tailwind-docs",
10-
"bradlc.vscode-tailwindcss",
11-
"Orta.vscode-jest",
12-
"ms-playwright.playwright"
7+
"bradlc.vscode-tailwindcss"
138
]
149
}

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Gearbox: Intuitive, Powerful Scouting at [4026.org](https://4026.org)
22

33
The final incarnation of Scout Janssen.
4-
54
Rewritten fully in Typescript, written to be easy to maintain and modular.
65
Features full feature parity with SJ2, whilst remaining simpler, faster and cooler.
6+
Used by 190+ teams worldwide to collect 380,000+ datapoints across 230+ competitions.
77

88
## Features
99

@@ -82,6 +82,61 @@ You've made it past set up and are ready to contribute to the future of scouting
8282

8383
We recommend you start with issues labelled `good first issue` to get a feel for the codebase. Fork the repo (unless you're part of Decatur Robotics, in which case make a new branch) and then make a pull request to the main branch. We'll review it and, if it looks good, merge it.
8484

85+
## Other Repositories
86+
87+
Our Terraform code is in a separate repository, [Gearbox-Terraform](https://github.com/Decatur-Robotics/Gearbox-Terraform).
88+
89+
We've also developed several packages that we use (available through NPM):
90+
91+
- [mongo-anywhere](https://github.com/Decatur-Robotics/mongo-anywhere) - Provides dependency injection and mocks for MongoDB. Gearbox has wrappers around this package's `DbInterface` types.
92+
- [unified-api](https://github.com/Decatur-Robotics/unified-api) - Provides handling and structure for API routes.
93+
- [unified-api-nextjs](https://github.com/Decatur-Robotics/unified-api-nextjs) - Provides types and templates for Next.js API routes.
94+
- [omit-call-signature](https://github.com/Decatur-Robotics/omit-call-signature) - Provides a type for removing call signatures from another type and a type for removing constructor signatures from a class type. Gearbox doesn't directly use this package, but the `unified-api` package does.
95+
96+
## Tools Used
97+
98+
### Codebase
99+
100+
- Typescript
101+
- Next.js
102+
- NextAuth
103+
- MongoDB
104+
105+
### Testing
106+
107+
- Jest
108+
- Playwright
109+
110+
### Dev Tools
111+
112+
- GitHub Actions
113+
- Prettier
114+
- ESLint
115+
116+
### Hosting & Infrastructure
117+
118+
See the [Gearbox-Terraform](https://github.com/Decatur-Robotics/Gearbox-Terraform) repository for more details.
119+
120+
- Terraform (stored in the [Gearbox-Terraform](https://github.com/Decatur-Robotics/Gearbox-Terraform) repository)
121+
- HashiCorp Managed Terraform (to apply the Terraform code)
122+
- AWS ECS
123+
- AWS S3 (to store secrets)
124+
- Cloudflare (for DNS)
125+
- MongoDB Atlas
126+
- Docker
127+
- GitHub Actions
128+
- GitHub Container Registry
129+
130+
### External APIs
131+
132+
- The Blue Alliance API (for match data)
133+
- The Orange Alliance API (for match data)
134+
- Rollbar (for error tracking and deployment notifications)
135+
- Resend (for email sending)
136+
- Google Analytics
137+
- Google OAuth (for authentication)
138+
- Slack OAuth (for authentication)
139+
85140
## Contibutors
86141

87142
<a href="https://github.com/Decatur-Robotics/Gearbox/graphs/contributors">

0 commit comments

Comments
 (0)