An open API service indexing awesome lists of open source software.

https://github.com/amriteshanand0129/notes-vault

This is the first version of NotesVault, built using EJS and NodeJS. A collaborative platform for university students to access and contribute study notes in one convenient place.
https://github.com/amriteshanand0129/notes-vault

ejs express mongodb nodejs user-authentication

Last synced: 3 months ago
JSON representation

This is the first version of NotesVault, built using EJS and NodeJS. A collaborative platform for university students to access and contribute study notes in one convenient place.

Awesome Lists containing this project

README

          

# 📚 NotesVault – Your Digital Repository for University Notes

![GitHub stars](https://img.shields.io/github/stars/amriteshanand0129/Notes-Vault)
![GitHub forks](https://img.shields.io/github/forks/amriteshanand0129/Notes-Vault)
![license](https://img.shields.io/github/license/amriteshanand0129/Notes-Vault?)

## 🚀 About the Project

**NotesVault** is a collaborative platform designed to facilitate **easy access to university notes** for college students. It also empowers students to **showcase their expertise** by uploading their own notes and resources.

🔗 **Live Demo**: [NotesVault on Render](https://notesvault.onrender.com)
_Please note that the website may take up to 50 seconds to load initially. This delay occurs because the server enters a dormant state after a period of inactivity._

> **📢 Work in Progress:** A second version, **NotesVault_V2**, is currently under development using the **MERN stack**, featuring **advanced authentication with Auth0** and **deployment on AWS**. Stay tuned! 🚀

---

## ✨ Key Features

- 📥 **Download University Notes** – Access a wide range of categorized study materials.
- 📤 **Upload & Share Notes** – Contribute your own notes and help fellow students.
- 🔍 **Advanced Search** – Easily find notes using keywords, subjects, or categories.
- 🔒 **JWT-based Authentication** – Secure login and access control.
- 🎨 **Bootstrap-Powered UI** – Clean, responsive, and user-friendly design.
- 🖥️ **Deployed on Render** – Live and ready for use.

---

## 🛠️ Tech Stack

- **Frontend**: CSS, EJS, Bootstrap
- **Backend**: Node.js, Express.js
- **Database**: MongoDB (Hosted on Atlas)
- **Authentication**: JWT (JSON Web Token)
- **Deployment**: Render.com

---

## 📦 Installation & Setup

### 1️⃣ Clone the Repository
```bash
git clone https://github.com/amriteshanand0129/Notes-Vault.git
cd NotesVault
```
### 2️⃣ Install Dependencies
```bash
npm i
```

### 3️⃣ Set Up Environment Variables
Create a .env file in the root directory and add the following:
```bash
DB_URL = YOUR_DATABASE_URL
PORT = BACKEND_SERVER_PORT (e.g 8080)
secret = SECRET_OF_YOUR_CHOICE
```

### 4️⃣ Start the Server
```bash
npm start
```

The server will start at http://localhost:PORT

### 📬 Contact & Support
For any issues or suggestions, feel free to open an issue on GitHub or contact me via email: amritesh2901@gmail.com