Welcome to Shoppy, Shoppy is a portfolio project designed to showcase a seamless online shopping experience. With features like user login, sign-up, Google login, a great UI, and Redis for caching, it offers a robust and efficient platform for modern e-commerce.
To get started with the project, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/Gaurav-jo1/E-commerce.git
-
Navigate to the project directory:
cd E-commerce
-
Install the frontend project dependencies:
cd frontend && npm install
-
Set up the backend environment (optional for development):
- Create a virtual environment:
cd backend && virtualenv venv
- Activate the virtual environment and install dependencies:
source ./venv/bin/activate && pip install -r requirements.txt
- Create a virtual environment:
-
For Google Sign-In credentials (optional):
-
Set up a Google API Console project and configure the consent screen:
- Go to the Google API Console
- Create a new project
- Click on "Create credentials" and select "OAuth client ID"
- Select "Web application" as the application type
- Enter a name for your OAuth client ID
- Add the authorized JavaScript origins and redirect URIs for your website
- Click "Create"
- Note down your client ID and client secret.
-
Refer to this Video tutorial for setting up the Google API console.
-
Download the JSON file with your Google API credentials, name it
client_secret.json
, and place it in thefrontend
directory.
-
-
Add the Google client ID to the backend
.env
file:GOOGLE_CLIENT_ID='your_google_client_id'
-
Run the application: Navigate to the root directory and start the services with Docker:
docker compose up
Access the application at: 🔗 http://localhost:5173
That's it! You should now be able to get started with the project and use Docker Compose to run the application. If you have any questions or issues, feel free to open an issue on the repository. Thanks for using my project!