Giter VIP home page Giter VIP logo

studycomrades's Introduction

📚🤝StudyComrades - we study together

Introduction

StudyComrades is a web-based platform designed to facilitate collaborative studying among students. It provides features such as note sharing(images), real-time chat, and the ability to search and add fellow comrades.

Technologies Used

  • React
  • Vite
  • Firebase (Authentication, Firestore)
  • JavaScript (JS)
  • HTML
  • CSS (with SASS)
  • Node.js
  • Bulma

Getting Started

Follow these steps to set up and run the project locally:

Step 1: Clone the Repository

git clone https://github.com/nisoojadhav/studycomrades.git
cd studycomrades

Step 2: Install Dependencies

yarn install

Step 3: Configure Firebase

  1. Create a Firebase project on the Firebase Console.
  2. Obtain the Firebase configuration object (apiKey, authDomain, projectId, etc.).
  3. Replace the configuration in src/firebase.js with your own.

Step 4: Run the Development Server

yarn run dev

Usage

Authentication

  • Sign up for an account on the StudyComrades platform.
  • Log in with your credentials.

Chatting with Comrades

  • Just select your friend to talk with.
  • Type the message and just click send.

Real-time Chat

  • Head over to the "Chat" section.
  • Add comrades using their usernames.
  • Engage in private, real-time conversations.

Searching and Adding Comrades

  • Use the search bar to find fellow comrades.
  • Click on their profiles and send a request to add them.

Logging Out

  • Click on your profile icon and select "Log Out" from the dropdown menu.

Hosting and Deployment

Additional Information

  • The codebase can be found at https://github.com/nisoojadhav/studycomrades/.
  • Firebase Functions are integrated with React JS to handle various operations.
  • The bundling is handled by Vite JS, a minimal package builder for React JS sites. The build command is generated using yarn build.

studycomrades's People

Contributors

nisoojadhav avatar

Watchers

 avatar

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.