Jobify

Welcome to the Jobify App! This is a job seeker application built using the MERN (MongoDB, Express.js, React, and Node.js) stack. It allows users to register, log in, and search for job listings. Users can also create, update, and delete their own job listings. The app also provides additional features such as password reset, survey email notifications, credit charging, and image uploads.
Deployed via Render https://mern-app-jobify.onrender.com.

Table of Contents

• Installation
• Configuration
• API Documentation
• Features
• Project Background

Installation

1. Clone the repository: git clone https://github.com/maryamalsadat-tabatabaei/Jobify.git
2. Navigate to the project directory: cd Jobify
3. Install dependencies: npm run setup-production
4. Set up the required environment variables for configuration.
5. Start the development server: npm run dev
6. Access the application in your browser at http://localhost:8000

Configuration

To configure the project, create .env file and add the following variables:

• PORT
• GOOGLE_MAP_API_KEY
• MONGO_DB_PASSWORD
• MONGO_DB_USER
• MONGO_DB_COLLECTION
• MONGO_DB_PORT
• JWT_SECRET
• GOOGLE_OAUTH_CLIENT_ID
• GOOGLE_OAUTH_CLIENT_SECRE
• SESSION_COOKIE_KEY
• SENDGRID_API_KEY
• STRIPE_SECRET_KEY
• STRIPE_PUBLISHABLE_KEY
• AWS_ACCESS_KEY
• AWS_SECRET_ACCESS_KEY

To configure the client, open the client folder and .env.development file and modify the following variables:

const config = { stripeKey: Your-stripe-key, googleClientID: Your-google-client-id-key };

API Documentation

User Authentication
POST /api/v1/auth/register: Register user by name, email, password, and image.
POST /api/v1/auth/login: Login user by email and password.
PATCh /api/v1/auth/updateUser: Update user information. Requires a JWT in the request headers.
GET /api/v1/auth/logout: Logout the user.
GET /auth/google: Use Google-passport-authentication.
GET /auth/callback: Use the Google-passport-authentication response and create JWT and redirect the user.
Job Listings
GET /api/v1/jobs: Retrieves a list of jobs. Requires a JWT in the request headers.
POST /api/v1/jobs: Create a job by company location and name. Requires a JWT in the request headers.
GET /api/v1/jobs/status: Show the status of jobs. Requires a JWT in the request headers.
DELETE /api/v1/jobs/:id: Delete the job. Requires a JWT in the request headers.
PATCH /api/v1/jobs/:id: Update the job. Requires a JWT in the request headers.
Password Reset
POST /api/v1/user/resetPassword: Create reset-password-token and reset-password-expiration-token for the existing user and send an email link to the user email for changing the password.
GET /api/v1/user/resetPassword/:token: Check the existing user by its token.
POST /api/v1/user/new-password: Save a new password for the user.
Survey Email Notifications
POST /api/v1/surveys: Create a new survey email notifier by title, subject, body, and recipients. Requires a JWT in the request headers. Also, require credits above 5$.
POST /api/v1/surveys/webhooks: Check the feedback based on the sent survey email.
Stripe Integration
POST /api/v1/stripe/charge": Charge the credit of the user. Requires a JWT in the request headers.
Image Upload
POST /api/v1/upload: Upload the image to the AWS S3 bucket. Requires a JWT in the request headers and the rate limit of 10 pic per 15 min.

Features

The Jobify App includes the following features:

• User Authentication:

  • Register new users with name, email, password, and image.
  • Log in existing users using email and password.
  • Update user information.
  • Log out the user.

• Google Authentication:

  • Authenticate users using Google OAuth 2.0.
  • Create JWT (JSON Web Token) and redirect users after successful authentication.

• Job Listings:

  • Retrieve a list of jobs.
  • Create a new job listing by providing company, location, and name.
  • Show the status of jobs.
  • Delete a job listing.
  • Update a job listing.

• Password Reset:

  • Generate reset-password tokens and expiration tokens for existing users.
  • Send an email link to users for changing their password.
  • Check user existence using the reset-password token.
  • Save a new password for the user.

• Survey Email Notifications:

  • Create and send survey email notifications.
  • Provide a title, subject, body, and recipients for the survey.
  • Requires a JWT and a minimum credit of 5$.

• Stripe Integration:

  • Charge the user's credit.
  • Requires a JWT for authentication.

• Image Upload:

  • Upload images to the AWS S3 bucket.
  • Requires a JWT and has a rate limit of 10 pictures per 15 minutes.

Project Background

This project is based on the work of John Smilga, and I would like to acknowledge their contributions. I have made modifications and added new features to extend the functionality of the original project and I built upon that foundation to extend the project's functionality and address specific requirements. However, the core concept and initial implementation were inspired by the course and the work of the original author.

New Features

1. Reset Password Functionality: Implemented the ability for users to reset their passwords if they forget or need to update them.

2. Uploading Image Functionality: Added the feature that allows users to upload images to enhance their profiles.

3. Stripe Integration for Credit Charging: Integrated Stripe payment processing to enable users to charge and manage credit on their accounts.

4. Google-OAuth Authentication: Introduced Google-OAuth as an additional authentication option, allowing users to sign in with their Google accounts.

5. Email Functionality: Integrated email functionality to send important notifications, updates, and notifications to users.

These additional features enhance the capabilities of the original project and provide added value in terms of functionality, performance, or user experience. They were implemented based on the requirements and insights gained from the course, as well as personal experimentation and problem-solving.

I would like to express my gratitude to the John Smilga course instructors for their teachings and inspiration, which played a significant role in the development of this project. Please note that this project is not affiliated with or endorsed by John Smilga, and any issues or inquiries regarding this modified version should be directed to my GitHub repository.