Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.93 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.93 KB
Raw

📚 Study Space

Study Space is a platform designed to facilitate offline learning and collaboration. It allows students and educators to create and join study sessions in physical locations, making it easy to connect with others for in-person learning experiences.

🌟 Features

  • Create Study Spaces: Organize study sessions by specifying the subject, location, date, and time. Ideal for teachers, tutors, or study groups looking to gather in person.
  • Join Study Spaces: Find and join local study spaces that match your interests and schedule. Perfect for those who prefer in-person interactions.
  • Event Invitations: Invite others to your study space via personalized invites. Share details such as the venue, time, and subject matter.
  • Local Notifications: Get reminders for upcoming study sessions and never miss an opportunity to learn or teach.

Technologies Used 🚀

  • React: A JavaScript library for building user interfaces.
  • Recoil: For state management.
  • Tailwind CSS: A utility-first CSS framework for styling.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
  • Fetch API: For making HTTP requests.
  • React Suspense: For handling lazy-loaded components.
  • Async/Await: For managing asynchronous operations.
  • Hosting : Vercel

🚀 Getting Started

Prerequisites

  • npm (or yarn)

Installation

  1. Clone the repository: 
    git clone https://github.com/sreecharan-desu/study-space.git
cd study-space
  2. Install dependencies:
npm install
  1. Run Website
npm run dev

Open your browser and visit http://localhost:5173.

🛡️ Security Authentication: Secure user authentication using OTP.

📄 License This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing Contributions are welcome! Please fork the repository, create a new branch, and submit a pull request.