MeGuie

Table of Contents

1. Introduction
2. Requirements
3. Installation
4. How to Use
5. Project Variants
6. Environment Variables

Introduction

MeGuie is an innovative platform that helps organize and structure study plans based on roadmaps for middle and high school subjects. By curating quality content, MeGuie provides a clear and practical guide to optimize study time and improve outcomes for students preparing for college entrance exams.

Requirements

To run the project locally, you will need:

• Node.js (v20 or higher)
• MongoDB Atlas (Cloud Database)

Installation

1. Clone the Repository

git clone https://github.com/lfelipediniz/MeGuie.git

Navigate to the project folder:

cd MeGuie

2. Install Dependencies

npm install 

3. Start the Development Server

npm run dev

By default, the server will run at http://localhost:3000.

How to Use

1. Access the Application:
   Open http://localhost:3000 or use the hosted versions:

   • Full Project (APOO Version): https://meguie.netlify.app
   • IHC Prototype: https://meguie.vercel.app

2. Log in with Test Accounts (APOO Version Only):
   These credentials are valid only for the APOO Version hosted at https://meguie.netlify.app.

   • Admin Account

     • Email: [email protected]
     • Password: 123456

   • User Account

     • Email: [email protected]
     • Password: 123456

Project Variants

1. APOO Version (Object-Oriented Analysis and Design)

Developed for the Object-Oriented Analysis and Design course, this version includes:

• Full backend integration with MongoDB Atlas.
• User authentication with JWT tokens.
• Complete study roadmap functionality.

Live Site: https://meguie.netlify.app

2. IHC Version (Human-Computer Interaction)

Developed for the Human-Computer Interaction course, this prototype focuses on:

• Basic frontend features.
• Accessibility-centered design.

Live Prototype: https://meguie.vercel.app

Environment Variables

To run the project locally, create a .env file in the root directory and add the following variables:

MONGODB_URI=mongodb+srv://<username>:<password>@cluster.mongodb.net/meguie
JWT_SECRET=your_jwt_secret_key

• MONGODB_URI: The connection string for your MongoDB Atlas database. Ensure your credentials are correct.
• JWT_SECRET: A secret key for signing and verifying JWT tokens for authentication.

About the Project

This project was developed as part of the Human-Computer Interaction and Object-Oriented Analysis and Design courses at USP.

For more information about these courses, visit:

• SCC0260 - Human-Computer Interaction
• SSC0124 - Object-Oriented Analysis and Design

Happy Learning! 📚🚀