Skip to content

xingyi1145/SE-StudyCenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SE-StudyCenter

SE-StudyCenter is a full-stack web application for sharing CS study materials, notes, and summaries using a Card-based UI and Markdown editor.

🚀 Quick Start

Get started in one step:

python3 start.py

This script handles everything: environment setup, dependencies, database seeding, and server launch.

Access the App:

Login Credentials:

  • Student: alice / password123
  • Professor: prof_smith / password123

✨ Features

  • Markdown Notes: Create and preview rich text study notes.
  • Card UI: Organize content visually with topic badges.
  • Engagement: Like, comment, and share notes.
  • Role-Based Access: Professors manage courses/topics; students contribute content.

🛠️ Tech Stack

  • Backend: Python (FastAPI), SQLAlchemy, SQLite.
  • Frontend: React (TypeScript, Vite), React Mde.

💻 Developer Guide

Manual Setup

If you prefer manual control:

  1. Backend: Create venv, install requirements.txt, run uvicorn src.backend.main:app --reload.
  2. Frontend: cd src/frontend, npm install, npm run dev.

Troubleshooting

  • Connection Failed? Try an Incognito window or clear localStorage.
  • Ports in Use? Run pkill -f uvicorn && pkill -f vite to free ports 8000/5173.
  • Reset Application? Run python3 start.py again to clean and restart.

Documentation

👥 Team

Yi Xing

About

SE-StudyCenter is a full-stack web application for sharing CS study materials, notes, and summaries using a Card-based UI and Markdown editor.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors