Prerequisites
This page lists the tools, services, and configurations required to work on the AggieSeek codebase and run the platform locally.
🧰 Developer Tools
Ensure you have the following tools installed:
| Tool | Recommended Version | Notes |
|---|---|---|
| Node.js | 18.x or 20.x | Used for building the Next.js frontend |
| npm | 8.x or later | Comes with Node.js |
| Python | 3.10+ | Used for running backend services |
| pip | Latest | Python package installer |
| Docker | 20.10+ | Used for containerizing and running all services |
| Git | Any recent version | Version control |
| PostgreSQL CLI | Optional | Useful for querying Amazon RDS locally |
💻 Local Setup Requirements
- Operating System: MacOS, Linux, or WSL on Windows
- Editor: VS Code (recommended) with extensions:
- ESLint
- Prettier
- Docker
- Python
🌐 Accounts & Access
You’ll need access to:
- Amazon RDS instance credentials (provided separately)
- Twilio API keys (for notifications)
- Discord bot token & webhook URL (if testing)
- Google OAuth Client ID & Secret (for local auth via NextAuth)
These secrets should be stored in a local
.envfile and are never committed to Git.
📁 Project Repositories
All repositories are listed under the AggieSeek organization on GitHub.
| Directory | Description |
|---|---|
aggieseek |
Next.js frontend (pages, components, API routes) |
aggieseek-tracker |
Python script to monitor tracked sections |
section-updater |
Python script to update public course database |
aggieseek-docs |
MkDocs-based developer documentation |
🔑 Environment Variables
See Environment Variables for a full list of required secrets and config keys.
✅ Next Step
Once these tools and accounts are set up, continue to Local Development to run the app locally.