https://github.com/pycreater/gmail-clone
gmail clone for learning purpose
https://github.com/pycreater/gmail-clone
Last synced: 10 months ago
JSON representation
gmail clone for learning purpose
- Host: GitHub
- URL: https://github.com/pycreater/gmail-clone
- Owner: Pycreater
- License: mit
- Created: 2024-08-11T09:40:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T06:03:22.000Z (almost 2 years ago)
- Last Synced: 2025-03-12T03:44:04.497Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://gmail-clone-mu-eight.vercel.app
- Size: 321 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/Pycreater/gmail-clone.git
```
### Set Up the Backend
Navigate to the backend directory:
```bash
cd gmail-clone/backend
```
Install the dependencies:
```bash
yarn install
```
Create a `.env` file in the backend folder:
```bash
cp .env.sample .env
```
Open the newly created `.env` file and add your credentials where necessary.
Start the backend server:
```bash
yarn start
```
### Set Up the Frontend
Navigate to the frontend directory:
```bash
cd ../frontend
```
Install the dependencies:
```bash
npm install
```
Start the frontend server:
```bash
npm run dev
```
Open your browser and visit:
```bash
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](./CONTRIBUTING.MD).
### License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
### Contact
If you have any questions or need further assistance, please reach out to us at pratikyadav3949@gmail.com.
