PromoCHATor web client

🚀 About

PromoCHATor is a recommendation system that helps WUST students find their ideal diploma thesis supervisor. The system is based on machine learning techniques and data scraped from the web.

🔥 Features

Current web app allows to:

• receive recommended supervisors based on the user's thesis topic/short description
• save supervisors to favourites
• give feedback about the recommended supervisor to fine-tune the model

👨‍🔧 Team

• Maciej Król - Tech Lead
• Maciej Malinowski - Frontend Developer
• Maciej Talarczyk - UI/UX Designer, Frontend Developer
• Wojciech Kosmalski - Frontend Developer, Project Manager

👀 Technologies

• 
• 
• 
• 
• 

🔗 Links

• Application
• Project portfolio

🔧 Development

1. Clone the Repository

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

2. Install Dependencies

cd web-promochator
pnpm i

3. Configure Environment

Copy and paste .env.example file in the root directory, rename the copy to .env and set the following content:

PROMOCHATOR_API=<promochator-api-url>
NEXT_PUBLIC_LOCK_DURATION_SECONDS=<default-to-60>
BUG_REPORT_FORM_URL=<google-form-url>
BUG_REPORT_FORM_EMAIL=<form-entry>
BUG_REPORT_FORM_DESCRIPTION=<form-entry>
BUG_REPORT_FORM_STEPS=<form-entry>

4. Run the Project

pnpm 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 feat/{issue_number}-my-feature-branch

3. Make your changes and commit:

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

4. Push to remote:

   git push origin feat/{issue_number}-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 feat/{issue_number}-my-feature-branch
  git push origin --delete feat/{issue_number}-my-feature-branch

📞 Contact

For questions or suggestions, reach out to us:

• ✉️ Email: kn.solvro@pwr.edu.pl
• 🌐 Website: solvro.pwr.edu.pl
• 📘 Facebook: KN Solvro

---

We appreciate your interest in our project! 🥰