https://github.com/talaganarajesh/getmaterial

A notes sharing website where students of NIST can get notes from seniors who contribute in this
https://github.com/talaganarajesh/getmaterial

ai expressjs firebase nodejs reactjs tailwind-css

Last synced: about 1 month ago
JSON representation

A notes sharing website where students of NIST can get notes from seniors who contribute in this

• Host: GitHub
• URL: https://github.com/talaganarajesh/getmaterial
• Owner: talaganaRajesh
• Created: 2024-11-28T13:45:25.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-06T11:57:26.000Z (about 1 month ago)
• Last Synced: 2024-12-06T12:31:42.340Z (about 1 month ago)
• Topics: ai, expressjs, firebase, nodejs, reactjs, tailwind-css
• Language: JavaScript
• Homepage: https://getmaterial.vercel.app
• Size: 31.6 MB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🚀 GetMaterial

**A collaborative notes-sharing platform for NIST students.**  

GetMaterial allows students to access notes shared by their seniors, fostering a supportive academic community. 📚

---

## 🌟 Features

- 📝 **Contribute Notes:** Senior students can upload notes for various subjects.

- 🔍 **Browse Notes:** Juniors and peers can search and download study materials easily.

- 📱 **Responsive Interface:** Optimized for both mobile and desktop devices.

---

## 🛠️ Tech Stack

- **Frontend:** ReactJS, Tailwind CSS

- **Backend:** Node.js, Express.js

- **Database:** Firebase

- **Deployment:** Vercel

---

## 🧑‍💻 Setup Guide

1. **Clone the Repository:**

   ```bash

   git clone https://github.com/talaganaRajesh/getmaterial.git

   cd getmaterial

Install Dependencies:

cd frontend

npm install

cd ../server

npm install

Configure Firebase:

Create a Firebase project.

Update the .env files in both the frontend and server directories with your Firebase credentials.

Start the Application:

# Frontend

cd frontend

npm start

# Backend

cd ../server

npm start

Access the App:

Open http://localhost:3000 to view the app locally.

🤝 Contribution Guidelines

Fork the repository and create a new branch for your feature.

Submit a pull request with a clear description of your changes.

Ensure the code follows the project's style and passes all tests.

Happy Coding! 😊

---

### Key Points:

- **Icons:** Emojis add visual appeal.

- **GIFs:** You can replace the sample GIF link with one relevant to your project.

- **Links:** Use external images or GIFs hosted online for a dynamic touch. 

This enhances readability and engages contributors! ✨