Skip to content

lenguyenduyphuc/The-Directory

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 

Repository files navigation

The Directory

[Demo Link]

📚 Overview

The Directory is an educational resource-sharing platform built with the MERN stack. It connects students and teachers, enabling them to share, organize, and evaluate educational resources through a community-driven voting system.

✨ Key Features

🔐 User Authentication

  • Secure registration and login
  • Password encryption with bcrypt
  • JWT-based authentication
  • Secure session management

📑 Resource Management

  • Subject-based organization
  • Easy link sharing
  • Community voting system
  • Popularity tracking
  • Automatic content sorting

🛠️ Technical Stack

Frontend

React

  • React Router for navigation
  • Axios for API calls
  • Modern CSS styling

Backend

Node.js Express.js

  • RESTful API architecture
  • JWT authentication
  • Bcrypt encryption
  • CORS enabled

Database

MongoDB

  • Optimized collections
  • Indexed queries
  • Relational data structure

🚀 Setup and Installation

  1. Clone Repository
git clone https://github.com/lenguyenduyphuc/The-Directory.git
  1. Install Dependencies
# Frontend setup
cd frontend
npm install

# Backend setup
cd ../backend
npm install
  1. Environment Configuration
# Create and configure .env
cp .env.example .env
  1. Launch Application
# Start backend
npm run dev

# Start frontend (new terminal)
cd ../frontend
npm run dev

💡 Development Journey

Stack Evolution

  • Initially attempted with Python/Flask
  • Migrated to MERN stack for:
    • Better documentation
    • Unified JavaScript
    • Enhanced real-time capabilities

Technical Challenges Solved

  • Robust API architecture
  • Secure authentication system
  • Real-time voting mechanism

Contributions are welcome! Please check our Contributing Guidelines.

📄 License

Licensed under the MIT License.


Created with 💻 by Nguyen Duy Phuc Le

This version:

  • Uses emojis for better visual organization
  • Includes technology badges
  • Has clearer section hierarchy
  • Is more visually appealing
  • Maintains professional formatting
  • Is easier to scan and read
  • Includes clear setup instructions
  • Has a modern, clean look

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors