Giter Club home page Giter Club logo

studydrive's Introduction

StudyDrive ๐Ÿ“š

A full stack web application that makes studying easier for students and document management hassle-free for teachers. Students can easily find study materials sorted by subjects and courses, while teachers can upload, organize, and manage resources effortlessly. StudyHub encourages teamwork, makes study materials easy to access, and acts as a hub for all educational resources ๐Ÿš€

Features ๐ŸŒŸ

  • Lightweight:: Crafted with minimalistic UI design.
  • PWA: Install as a Progressive Web App on your device.
  • Easy Navigation: Students can effortlessly find study materials, sorted by subjects, courses, and categories.
  • Advanced Search: Powerful search functionality to quickly locate specific study materials.
  • Document Management: Teachers can easily upload, organize, and manage a variety of educational resources.
  • Admin Dashboard: Admins can conveniently control and manage users and roles.
  • Security Measures: Ensuring secure file upload and storage..
  • User Authentication: Secure login for teachers and admin.
  • Responsive Design: User-friendly experience on various devices.

Tech Stack ๐Ÿ› ๏ธ

  • NEXT.JS: React-based framework for building modern web applications.
  • Tailwind CSS: Utility-first CSS framework for highly customizable UIs.
  • MongoDB: NoSQL database for flexible and scalable data storage.
  • NextAuth: Authentication solution for Next.js with social logins and more.
  • Prisma: Modern database toolkit for simplified data access.
  • Zustand: Lightweight state management library for React.

Getting Started ๐Ÿšฆ

Prerequisites ๐Ÿšง

Environment Variables โš™๏ธ

To run this project, you will need to add the following environment variables to your .env file:

  • NEXTAUTH_URL :The public URL of your NextAuth authentication service.
  • NEXTAUTH_URL_INTERNAL :The internal URL used for authentication within the project.
  • NEXTAUTH_SECRET :A secret key for securing sessions and tokens in NextAuth.
  • NEXT_SHARP_PATH:Path for Next.js image processing with Sharp.
  • NEXT_DEFAULT_PASSWORD:Default password used during project setup or user creation.
  • NEXT_PUBLIC_APP_URL:The public URL of your application.
  • DATABASE_URL :Your MongoDB connection URL.
  • EDGE_STORE_ACCESS_KEY:Access key for Edge Store,
  • EDGE_STORE_SECRET_KEY:Secret key for Edge Store

How To Use ๐Ÿš€

From your command line:

# Clone this repository
  $git clone https://github.com/your_github_name/studydrive.git

# Go into the repository
  $cd studydrive

# Install dependencies
  $npm install
  # <Create .env appropriately>

# This is needed if you are planning to run studydrive locally
  $npx prisma db push

# Start the app in development mode with hot-code reloading by running:
  $npm run dev

Contributing ๐Ÿค

We welcome contributions from the community. Please fork the repository and submit pull requests. Make sure to see contributing.md for instructions on contributing to the project!

Support ๐Ÿ’ฌ

Join Our Telegram Group For Support/Assistance And Our Channel For Updates.

Report Bugs, Give Feature Requests There..

Licence ๐Ÿ“

Studydrive is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the MIT License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

โญ๏ธ Star this Repo if you Liked it! โญ๏ธ

studydrive's People

Contributors

dependabot[bot] avatar imgbotapp avatar muzammilk03 avatar renovate[bot] avatar shabin-k avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

studydrive's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

npm
package.json
  • @heroicons/react ^2.0.17
  • dotenv ^16.0.3
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-router-dom ^6.10.0
  • @types/react ^18.0.28
  • @types/react-dom ^18.0.11
  • @vitejs/plugin-react ^4.0.0
  • autoprefixer ^10.4.14
  • postcss ^8.4.21
  • tailwindcss ^3.3.1
  • vite ^4.2.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.