README.md

getNOTES | Student Social e-Library

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 getNOTES

getNOTES is a Fullstack WebApp - mini e-library platform that allows the sharing of Notes in different formats (pdf, ppt, txt, docx, mp3 etc) from digital to audio notes. Built purposely to ease access to Lecture notes in the Faculty of Engineering (My Faculty) in my Institute. Notes are uploaded by the Students themselves and managed by an Admin.

🛠 Built With

Tech Stack

Client

• React.js
• SASS
• React Toastify

Server

• Firebase

Database

• FireStore

Key Features

• Upload/Add Notes
• Games Forum
• Forum - With over 10 Groups
• Sign Up
• Profile - Unique Username
• Profile Management
• Announcement Page

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Firebase Account

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/eimaam/get-notes.git

• Create New Project in Firebase Console
• Create .env.local file and paste the new firebase project configuration data according using the format REACT_APP_API_KEY= x132434

Install

Install this project with:

Use npm install or yarn install

  cd my-project
  npm install

Usage

To run the project, execute the following command:

  npm run start

Deployment

You can deploy this via Firebase or Vercel (make sure to add the env variables via Vercel settings environment variables)

(back to top)

🔭 Future Features

• Make open to all Faculties in the Institute
• Integrate a marketplace
• Add a Poll to the Forum

(back to top)

⭐️ Show your support

If you like this project kindly share and recommend my brand for Works.

📝 License

This project is MIT licensed.

(back to top)