https://github.com/eimaam/get-notes
A mini School Library built for the purpose of bringing ease to Students by bringing all their Lecture Notes/Documents into an easy to navigate environment with almost their full controll
https://github.com/eimaam/get-notes
e-library firebase react
Last synced: about 2 months ago
JSON representation
A mini School Library built for the purpose of bringing ease to Students by bringing all their Lecture Notes/Documents into an easy to navigate environment with almost their full controll
- Host: GitHub
- URL: https://github.com/eimaam/get-notes
- Owner: eimaam
- Created: 2022-09-14T01:40:25.000Z (almost 4 years ago)
- Default Branch: v1.1
- Last Pushed: 2024-01-03T10:43:00.000Z (over 2 years ago)
- Last Synced: 2025-02-07T12:46:51.919Z (over 1 year ago)
- Topics: e-library, firebase, react
- Language: JavaScript
- Homepage: https://getnotes.eimaam.dev
- Size: 3.48 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
getNOTES | Student Social e-Library
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**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.
Client
Server
Database
- **Upload/Add Notes**
- **Games Forum**
- **Forum - With over 10 Groups**
- **Sign Up**
- **Profile - Unique Username**
- **Profile Management**
- **Announcement Page**
- [Live Demo Link](https://getnotes.xyz)
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:
```sh
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`
```sh
cd my-project
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run start
```
### Deployment
You can deploy this via Firebase or Vercel (make sure to add the env variables via Vercel settings environment variables)
- [ ] **Make open to all Faculties in the Institute**
- [ ] **Integrate a marketplace**
- [ ] **Add a Poll to the Forum**
If you like this project kindly share and recommend my brand for Works.
This project is [MIT](./LICENSE) licensed.