ASU Survival Guide 🔱

A community-driven, open-source project to help Arizona State University students find the best deals, late-night food spots, and easy A classes.

🌵 About

Made by Sun Devils, for Sun Devils.

The ASU Survival Guide is your go-to resource for navigating life at Arizona State University. Whether you're looking for:

• 🍔 Food spots that accept Maroon & Gold Advantage (M&G)
• 🌙 Late-night study spots and eateries
• 📚 Easy A classes with great professors
• 💰 Budget-friendly options around campus

This project is built and maintained by the ASU community to help fellow students thrive.

✨ Features

• Food Directory - Filter by M&G acceptance, late-night hours, and budget-friendly options
• Class Guide - Search classes by difficulty, professor, and Gen Ed requirements
• Community Suggestions - Submit and share tips with fellow Sun Devils
• Admin Dashboard - Manage content with a secure admin interface
• Responsive Design - Works perfectly on mobile (because you'll use this on the go!)

🛠️ Tech Stack

Technology	Purpose
Next.js 16	React framework with App Router
TypeScript	Type-safe JavaScript
Tailwind CSS 4	Utility-first styling
MongoDB Atlas	Cloud database
Mongoose	MongoDB ODM
Lucide React	Beautiful icons

🚀 Getting Started

Prerequisites

• Node.js 18+
• npm or yarn
• MongoDB Atlas account (free tier works!)

Installation

1. Clone the repository

   git clone https://github.com/p0oru/asu-guide.git
   cd asu-guide

2. Install dependencies

   npm install

3. Set up environment variables

   Create a .env.local file in the root directory:

   MONGODB_URI=mongodb+srv://your-connection-string
   ADMIN_SECRET=your-secure-admin-password

4. Seed the database (optional)

   npm run seed

5. Start the development server

   npm run dev

6. Open http://localhost:3000 in your browser 🎉

📁 Project Structure

asu-survival-guide/
├── public/
│   └── asu_trident.svg      # ASU branding assets
├── src/
│   ├── app/                 # Next.js App Router pages
│   │   ├── admin/           # Admin dashboard
│   │   ├── classes/         # Class directory
│   │   ├── community/       # Community suggestions
│   │   └── food/            # Food directory
│   ├── components/          # Reusable UI components
│   ├── lib/                 # Utilities & server actions
│   ├── models/              # Mongoose schemas
│   └── scripts/             # Database seeding
├── .env.local               # Environment variables (not committed)
└── package.json

🤝 Contributing

We welcome contributions from all Sun Devils! Here's how you can help:

Ways to Contribute

1. Add Food Spots - Know a hidden gem? Add it to the database!
2. Class Reviews - Share your experience with classes and professors
3. Bug Fixes - Found a bug? Submit a PR!
4. Feature Ideas - Open an issue to discuss new features

Contribution Steps

1. Fork the repository

2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make your changes

4. Commit with a descriptive message

   git commit -m "Add: New food spot - Pita Jungle"

5. Push to your fork

   git push origin feature/amazing-feature

6. Open a Pull Request

Code Style

• Use TypeScript for all new files
• Follow the existing component patterns
• Use Tailwind CSS for styling
• Write descriptive commit messages

🚢 Deployment

This project is designed to deploy on Render:

1. Create a new Web Service on Render
2. Connect your GitHub repository
3. Configure:
   • Build Command: npm run build
   • Start Command: npm start
4. Add environment variables:
   • MONGODB_URI
   • ADMIN_SECRET

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2026 ASU Survival Guide Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🙏 Acknowledgments

• All the Sun Devils who contributed food spots and class reviews
• The ASU community for inspiration
• Lucide for beautiful icons

---

Fork it up! 🔱
Made with ❤️ in Tempe, AZ