https://github.com/arsenic-01/studystack
Study Stack is a platform where teachers/faculty can upload notes and resources for their respected subjects and students can access them, much like google classroom, but better.
https://github.com/arsenic-01/studystack
appwrite-database appwrite-storage authentication aws-s3 diploma-project msbte nextjs15 notes-app tailwindcss
Last synced: 10 months ago
JSON representation
Study Stack is a platform where teachers/faculty can upload notes and resources for their respected subjects and students can access them, much like google classroom, but better.
- Host: GitHub
- URL: https://github.com/arsenic-01/studystack
- Owner: Arsenic-01
- Created: 2025-01-28T15:29:50.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-03-23T10:49:38.000Z (10 months ago)
- Last Synced: 2025-03-23T11:22:14.637Z (10 months ago)
- Topics: appwrite-database, appwrite-storage, authentication, aws-s3, diploma-project, msbte, nextjs15, notes-app, tailwindcss
- Language: TypeScript
- Homepage: https://studystack01.vercel.app
- Size: 36.7 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 StudyStack
A centralized platform for students and teachers to manage and share study materials efficiently.
🔗 **Live Website:** [StudyStack](https://studystack01.vercel.app/)
🔗 **Source Code:** [GitHub Repository](https://github.com/Arsenic-01/studystack)
---
## 🎥 Demo
[](https://youtu.be/bcyYHZSmW88)
Click the image above to watch the video.
---
## 🚀 About StudyStack
StudyStack is a **notes storage platform** designed for colleges where:
- **Students** can browse and download notes easily.
- **Teachers** can upload study materials for their students.
- **Admins** have full control over managing content and user access.
It provides a **fast, secure, and scalable** solution for academic content sharing.
---
## 🌟 Features
✅ **Students:** View and download notes seamlessly.
✅ **Teachers:** Upload study materials effortlessly.
✅ **Admin Panel:** Manage users, notes, and permissions.
✅ **Role-based Access Control (RBAC)** to ensure proper authorization.
✅ **Fast and Secure Storage** for reliable access.
✅ **Modern UI/UX** for a smooth user experience.
---
## 🛠️ Tech Stack
### **Frontend:**
- 🚀 **Next.js (App Router)**
- 🎨 **Tailwind CSS**
- ⚡ **React 19 (RSC)**
### **Backend & Storage:**
- 📦 **Appwrite** (Database & Storage)
- 🔑 **Appwrite** (Authentication)
- ⚡ **Vercel** (Serverless/Edge Functions)
- 🌐 **Vercel + Netlify** (Hosting)
### **State Management:**
- 🏗️ **Zustand** (Efficient state handling)
- 🔄 **React Query** (Data fetching & caching)
---
## 🔧 Setup & Installation
1️⃣ **Clone the Repository**
```sh
git clone https://github.com/Arsenic-01/studystack.git
cd studystack
```
2️⃣ **Install Dependencies**
```sh
npm install
```
3️⃣ **Set Up Environment Variables**
Create a `.env.local` file in the root directory and add the required credentials:
```env
PROJECT_ID=your_project_id
API_KEY=your_api_key
DATABASE_ID=your_database_id
USER_COLLECTION_ID=your_user_collection_id
NOTE_COLLECTION_ID=your_note_collection_id
NEXT_PUBLIC_ENDPOINT=https://cloud.appwrite.io/v1
NEXT_PUBLIC_BASE_URL=
NEXT_PUBLIC_LOCAL_URL=http://localhost:3000
BUCKET_ID=your_bucket_id
RESEND_API_KEY=your_resend_api_key
NEW_SUBJECT_COLLECTION_ID=your_new_subject_collection_id
YOUTUBE_COLLECTION_ID=your_youtube_collection_id
SESSION_COLLECTION_ID=your_session_collection_id
LOGIN_COLLECTION_ID=your_login_collection_id
```
4️⃣ **Run the Development Server**
```sh
npm run dev
```
Visit `http://localhost:3000/` to view the app locally.
---
## 🤝 Contributing
1. **Fork the repository**
2. **Create a new branch:** `git checkout -b feature-branch`
3. **Commit your changes:** `git commit -m "Added new feature"`
4. **Push to your branch:** `git push origin feature-branch`
5. **Submit a pull request** 🎉
---
## 📜 License
This project is licensed under the **MIT License**.
---
## 📬 Contact
💡 Got suggestions or feedback? Feel free to connect!
📧 **Email:** [vedbhor25@gmail.com](mailto:vedbhor25@gmail.com)
🐦 **Twitter:** [@arsenic_dev](https://x.com/arsenic_dev)
👨💻 **LinkedIn:** [Vedant Bhor](https://www.linkedin.com/in/vedant-bhor-39287828b/)