htirawi / apartment-pulse

Apartment Pulse Web App using React and Next.js

Apartment Pulse

« Try the demo here »

A web application to help you find your apartment.

This is the main project URL deployed to Vercel Apartment Pulse

Features

Here are some of the current features that this web application has:

• User authentication with Google & Next Auth
• User authorization
• Route protection
• User profile with user listings
• Apartment Listing CRUD
• Apartment image upload (Multiple)
• Apartment search
• Internal messages with 'unread' notifications
• Photoswipe image gallery
• Mapbox maps
• Toast notifications
• Apartment bookmarking / saved apartments
• Apartment sharing to social media
• Loading spinners
• Responsive design (Tailwind)
• Custom 404 page

Apartment Pulse uses the following technologies:

• Next.js
• React
• Tailwind CSS
• MongoDB
• Mongoose
• NextAuth.js
• React Icons
• Photoswipe
• Cloudinary
• Mapbox
• React Map GL
• React Geocode
• React Spinners
• React Toastify
• React Share

Getting Started

Prerequisites

• Node.js version 18 or higher
• MongoDB Atlas account and a cluster. Sign up and create a cluster at MongoDB
• Cloudinary account. Sign up at Cloudinary
• Google console account. Sign up at Google Cloud
• Mapbox account. Sign up at Mapbox

.env File

Fill in the following environment variables:

• Get your MongoDB connection string from your MongoDB Atlas cluster and add it to MONGODB_URI.
• Get your Google client ID and secret from your Google console account and add them to GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET.
• Add a secret to NEXTAUTH_SECRET. You can generate with the following command:

  openssl rand -base64 32

• Get your Cloudinary cloud name, API key, and API secret from your Cloudinary account and add them to CLOUDINARY_CLOUD_NAME, CLOUDINARY_API_KEY, and CLOUDINARY_API_SECRET.
• Get your Mapbox token from your Mapbox account and add it to NEXT_PUBLIC_MAPBOX_TOKEN.
• Get your Google Geocoding API key from your Google console account and add it to NEXT_PUBLIC_GOOGLE_GEOCODING_API_KEY.

Install Dependencies

npm install

Run the Development Server

npm run dev

Open http://localhost:3000 with your browser to see the result.

License

This project is licensed under the MIT License - see the LICENSE.md file for details