Welcome to Fingcomms! This project is a simple directory that allows Fing (Facultad de Ingeniería, UdelaR) students to find and connect with study groups and projects.
Fingcomms allows you to:
- View a list of engineering student groups
- Search groups by name or category
- Add new groups to the directory
It's designed to help incoming students find study partners and collaborative projects.
- Backend (server-side): FastAPI + SQLite
- Frontend (visual interface): Vue.js
- Containers: Docker
Docker is a tool that lets you run applications in "containers" without manually installing dependencies.
-
Make sure Docker is installed on your computer
-
Open a terminal in the project folder
-
Run:
docker-compose up --build
-
Open your browser and visit:
http://localhost:8000
Done! The application is now running.
-
Make sure you have Python installed (version 3.9 or higher)
-
Create a virtual environment (an isolated workspace):
python -m venv venv
-
Activate the virtual environment:
- On Linux/Mac:
source venv/bin/activate - On Windows:
venv\Scripts\activate
- On Linux/Mac:
-
Install dependencies:
pip install -r requirements.txt
-
Run the server:
uvicorn main:app --reload
-
Open your browser at:
http://localhost:8000
Want to help improve Fingcomms? Excellent!
Check out our contribution guide in CONTRIBUTING.md for step-by-step instructions.
If you found a bug or have an idea for improvement:
- Check if someone already reported it in the Issues section
- If not, create a new Issue using the available templates
This project is under MIT license. See LICENSE for details.
New to development? Don't worry, we all started somewhere. If you have questions, feel free to ask in Issues or seek help from the Fing community.