🎓 USF Study Buddy

A web app to find study partners. The project was designed for HackJam 2025. Made with 💚 to USF Bulls.

Getting Started

Environment

cp ../.env.example ../.env   # PLEASE CHANGE THE VARIABLES' VALUES

Backend Setup

cd backend
poetry install
poetry run python main.py

The backend will run on http://localhost:8000

Frontend Setup

cd frontend
npm install
npm run dev

The frontend will run on http://localhost:5173

Screenshots

All the screenshots are located here

🤝 Contributing

This project was created for HackJam 2025. Contributions, issues, and feature requests are welcome!

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

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