Gmail Clone

Welcome to the Gmail Clone project! This project is a comprehensive email client clone with both backend and frontend components. Follow the instructions below to get started with development and run the project on your local machine.

Getting Started

Clone the Repository

First, clone the repository using the following command:

git clone https://github.com/Pycreater/gmail-clone.git

Set Up the Backend

Navigate to the backend directory:

cd gmail-clone/backend

Install the dependencies:

yarn install

Create a .env file in the backend folder:

cp .env.sample .env

Open the newly created .env file and add your credentials where necessary.

Start the backend server:

yarn start

Set Up the Frontend

Navigate to the frontend directory:

cd ../frontend

Install the dependencies:

npm install

Start the frontend server:

npm run dev

Open your browser and visit:

http://localhost:5173

Pages

Here's an overview of the pages you'll find in the application:

Home: Displays the main dashboard.
Inbox: Shows your list of received emails.
Sent: Lists emails that you have sent.
Drafts: Contains drafts of your emails.
Spam: Shows emails marked as spam.
Trash: Displays emails that have been moved to the trash.

Contributing

If you would like to contribute to the project, please fork the repository and submit a pull request with your changes. For detailed instructions on how to contribute, please refer to our CONTRIBUTING.md.