-
Notifications
You must be signed in to change notification settings - Fork 4
Simple Development
Create a fork of the repository to your own GitHub account. This will allow you to make changes to the repository without requiring privileges in the source repository. Create a Fork.
Clone your fork to begin development on your local machine.
Node.js is required to run the development tools. You can download the latest version of Node.js from nodejs.org.
Yarn is a package manager for Node.js. It is used to install the development tools and dependencies. You can download the latest version of Yarn from yarnpkg.com.
You can use any IDE you want to develop the project. Visual Studio Code & WebStorm both provide good support for TSX files.
Your local testing instance will require read access for both the FRC events & TBA APIs. You can request a TBA API key from thebluealliance.com. You can request an FRC Events API key from frc-events.firstinspires.org.
Create a .env file based on the .env.example file and add your API keys to the file.
Please note that you need to take your FRC events API key and base64 encode it you can do so through many methods but a simple online encoder is available at base64encode.org.
# Required
BLUE_ALLIANCE_API_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
FIRST_API_KEY="XXXXXXXXXXXXXXX"
# Optional
DATABASE_URL=
NEXT_PUBLIC_SECRET=
NEXTAUTH_URL=http://localhost:3000/api/auth
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=Note: If you include a DATABASE_URL, be sure to run the npx prisma db push command, to synchronize your Prisma schema with your database schema.
Run yarn install to install the development tools and dependencies. Then run yarn dev to launch the development
instance. The development instance will be available at localhost:3000.