README.md

🎓 Planer - University Scheduler

Welcome to the repository of the Solvro project, a student organization at the Wrocław University of Science and Technology!

🎯 Project Goal

The Solvro Planer project aims to create an intuitive and user-friendly application that helps students plan their academic schedule. Our planer is designed to:

• Minimize time spent on manual timetable adjustments
• Provide full control over your schedule

👥 Current Team

Role	Member
Project Manager	@unewMe
Fullstack Developer / Commander of the Unexpected	@D0dii
Fullstack Developer / Solution Wizard	@olekszczepanowski
Fullstack Developer / Engineer of the Impossible / Everyday Superhero	@qamarq

🚀 Technologies

• 
• 
• 
• 
• 

🔗 Links

• Live Application
• Project Portfolio

📊 Analytics

We have analytics available at our analytics dashboard.

For Solvro Planer version 1.0:

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/Solvro/web-planer.git

2. Install Dependencies

cd web-planer
npm install

3. Configure Environment

Create a .env file in the frontend directory with the following content:

SITE_URL=http://localhost:3000
USOS_CONSUMER_KEY=<your-key>
USOS_CONSUMER_SECRET=<your-key>
USOS_BASE_URL=<your-key-default-for-pwr:usos.pwr.edu.pl>

4. Run the Project

cd frontend && npm run dev

5. View the Application

Open your browser and navigate to http://localhost:3000.

🤝 Contributing

We welcome contributions! Here's how you can help:

• 🐛 Report bugs or suggest improvements
• 🌟 Request new features
• 🧪 Test and provide feedback

🔄 Git Workflow

Don't worry if you forget any steps – our automatic GitHub Action will run checks and notify you of any issues.

📘 Solvro GitHub Handbook

Check out our detailed GitHub workflow guide.

🔐 SSH Setup

For Windows users, follow this SSH setup tutorial.

🌿 Feature Development Workflow

1. Checkout and update main:

   git checkout main
   git pull origin main
   git fetch

2. Create a feature branch:

   git checkout -b WEB-x_my_feature_branch

3. Make your changes and commit:

   git add .
   git commit -m "My changes description"

4. Push to remote:

   git push origin WEB-x_my_feature_branch

5. Create a Pull Request on GitHub

⚠️ Important Reminders

• Never push directly to the main branch

• Always commit before checking out to a different branch

• After successful merge, clean up:

  git branch -d WEB-x_my_feature_branch
  git push origin --delete WEB-x_my_feature_branch

📞 Contact

For questions or suggestions, reach out to us:

• ✉️ Email: [email protected]
• 🌐 Website: solvro.pwr.edu.pl
• 📘 Facebook: KN Solvro

---

Thank you for your interest in our project! 🙌