https://github.com/mostafa-bashir/easyauth

https://github.com/mostafa-bashir/easyauth

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mostafa-bashir/easyauth
• Owner: mostafa-bashir
• Created: 2024-12-16T11:58:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-16T13:34:52.000Z (about 1 year ago)
• Last Synced: 2025-02-14T03:23:22.106Z (11 months ago)
• Language: EJS
• Size: 12.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Easy-Auth

## Node.js Project with MySQL, EJS, JavaScript, and CSS

### Description

This project is a web application built using Node.js, MySQL, EJS, and JavaScript. The application provides a simple authentication system with features for user registration, login, profile management, and additional enhancements for user convenience.

### Key Features

1. **User Signup and Login:**

   - Users can create an account by signing up with their name, email, password, and age.

   - Registered users can log in to access their profile and other main features.

2. **User Profile Management:**

   - Logged-in users can view and edit their profile information.

   - Users can upload a profile picture that is displayed on their profile.

   - All changes are saved to the MySQL database.

3. **Session-Based Authentication:**

   - The application uses sessions to maintain user authentication.

   - Users who are already logged in are redirected to the main screen without needing to log in again.

   - Unauthorized access to the main screen is blocked, and users are redirected to the login page if not authenticated.

4. **Email Verification:**

   - New users receive an email with a verification link to activate their account.

   - Only verified accounts can access the main application features.

5. **Forgot Password Feature:**

   - Users can request a password reset link via email.

   - A secure token is generated for resetting the password, ensuring secure password recovery.

6. **Environment Variables:**

   - Sensitive configurations, such as database credentials, are stored securely using `.env` files.

7. **Password Hashing:**

   - User passwords are securely hashed before being stored in the database.

8. **CSS Design:**

   - The application includes a clean and responsive design using CSS for better user experience.

### Technologies Used

- **Node.js:** Backend runtime environment for building server-side logic.

- **MySQL:** Relational database for storing user information.

- **EJS:** Templating engine for rendering dynamic views.

- **JavaScript:** Frontend scripting for interactivity and validation.

- **CSS:** For designing a responsive and visually appealing user interface.

- **dotenv:** For managing environment variables.

- **bcrypt:** For hashing passwords securely.

- **nodemailer:** For sending emails, including verification and password reset links.

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/mostafa-bashir/Easy-Auth.git

   ```

2. Navigate to the project directory:

   ```bash

   cd 

   ```

3. Install dependencies:

   ```bash

   npm install

   ```

4. Set up the MySQL database:

   - Create a database and import the provided SQL file (if available).

   - Create a `.env` file in the project root and add your database configuration:

     ```env

     DB_HOST=localhost

     DB_USER=your-username

     DB_PASSWORD=your-password

     DB_NAME=your-database-name

     ```

5. Configure email settings for verification and password reset:

   - Add email service configurations to the `.env` file:

     ```env

     EMAIL_HOST=smtp.your-email-provider.com

     EMAIL_PORT=your-email-port

     EMAIL_USER=your-email@example.com

     EMAIL_PASSWORD=your-email-password

     ```

6. Start the server:

   ```bash

   npm start

   ```

7. Open your browser and navigate to:

   ```

   http://localhost:8000

   ```

### Application Structure

- **Routes:**

  - `/signup`: User registration page.

  - `/login`: User login page.

  - `/main`: Main screen for logged-in users (profile management).

  - `/verify-email`: Email verification link endpoint.

  - `/forgot-password`: Password reset request page.

  - `/reset-password`: Secure password reset page.

- **Middleware:**

  - Session middleware ensures that only authenticated users can access the main screen.

  - Redirects unauthenticated users to the login page.

### Usage

1. **Sign Up:**

   - Navigate to the sign-up page.

   - Fill in your details, upload a profile picture, and create an account.

   - Check your email for a verification link to activate your account.

2. **Log In:**

   - Log in using your registered email and password.

3. **Edit Profile:**

   - After logging in, update your profile details and upload a new profile picture if desired.

   - Save changes to update the database.

4. **Forgot Password:**

   - If you forget your password, navigate to the "Forgot Password" page.

   - Enter your registered email to receive a password reset link.

   - Use the link to reset your password securely.

5. **Session Handling:**

   - Close and reopen your browser. If you are still logged in, you will be redirected directly to the main screen.

   - If not logged in, any attempt to access `/main` will redirect you to the login page.

### Future Enhancements

- Improve the email templates for a more professional look.

- Add multi-factor authentication (MFA) for enhanced security.

- Implement user activity logging for better account security and troubleshooting.

- Enhance CSS design with modern frameworks like Tailwind CSS or Bootstrap.

### License

This project is open-source and available under the [MIT License](LICENSE).

---

Feel free to contribute, report issues, or suggest improvements!

# EasyAuth