ES | Digital Dreams

El proyecto es un sitio web de comercio electrónico que ofrece una variedad de productos relacionados con la tecnología y la informática. El objetivo principal del proyecto es proporcionar a los usuarios una plataforma conveniente para comprar productos de calidad en línea. El sitio web incluirá características como filtros de búsqueda avanzados, autenticación de terceros y una pasarela de pagos segura.

Con esta plataforma de comercio electrónico, los clientes podrán explorar las diversas categorías, realizar búsquedas específicas, comparar productos, leer reseñas de otros compradores y realizar compras de manera segura. Además, se brindará un sistema de autenticación de terceros para facilitar el proceso de registro y acceso a la plataforma.

En resumen, el proyecto busca proporcionar una experiencia de compra en línea conveniente y segura para los amantes de la tecnología y los productos relacionados con la informática.

Categorías de productos disponibles:

• Equipos armados
• Consolas
• Notebooks
• Gabinetes
• Fuentes y UPS
• Motherboards
• Procesadores
• Cooling
• Memorias
• Almacenamiento
• Tarjetas de video
• Periféricos
• Monitores y TV
• Sillas
• Pendrives
• Impresoras

Tecnologías Utilizadas

Lista de las tecnologías más relevantes utilizadas en este proyecto:

Características de la Aplicación

• Autenticación de Terceros: Permite a los usuarios registrarse e iniciar sesión utilizando sus cuentas de terceros, como Google o Facebook.
• Carrito de Compras: Los usuarios pueden agregar productos al carrito de compras, ajustar las cantidades y realizar el proceso de compra.
• Reseñas y Puntuaciones: Los usuarios pueden dejar reseñas y puntuaciones para los productos, lo que ayuda a otros usuarios a tomar decisiones de compra informadas.
• Favoritos: Los usuarios pueden guardar productos en su lista de favoritos para poder acceder fácilmente a ellos más tarde.
• Pasarela de Pagos: Integración de una pasarela de pagos para permitir a los usuarios realizar transacciones seguras y completar el proceso de compra.
• Filtros y Ordenamientos: Los usuarios pueden aplicar filtros y ordenamientos para refinar su búsqueda de productos en la tienda.
• Barra de Búsqueda: Los usuarios pueden realizar búsquedas de productos utilizando palabras clave y obtener resultados relevantes.
• Gestión de Usuarios: Funcionalidad para administrar y gestionar la información de los usuarios, como editar perfiles, cambiar contraseñas, etc.
• Gestión de Productos: Permite a los administradores agregar, editar y eliminar productos en el catálogo de la tienda.
• Gestión de Reseñas: Los administradores pueden moderar y gestionar las reseñas de los productos, como aprobarlas, eliminarlas o responder a ellas. También se incluye un apartado de reportes para los malos comentarios.
• Gráficos (Dashboard): Ofrece un panel de control con gráficos y estadísticas visuales para proporcionar información sobre el rendimiento de ventas, análisis de productos, etc.

Instalación 💻

Sigue estos pasos para instalar el proyecto "DigitalDreams" utilizando npm.

Clona el repositorio de GitHub ejecutando el siguiente comando:

  git clone https://github.com/JuniorHuanca/DigitalDreams.git

Navega al directorio del proyecto clonado:

  cd DigitalDreams

Instala las dependencias del proyecto:

  npm install

Configuración de Variables de Entorno 🛠️

Para ejecutar este proyecto, deberá agregar las siguientes variables de entorno a su archivo .env

Autenticación con GitHub:

• Visita https://github.com/settings/developers en tu navegador y asegúrate de iniciar sesión en tu cuenta de GitHub.

• Haz clic en "New OAuth App" para crear una nueva aplicación OAuth.

• Completa los campos requeridos para tu nueva aplicación. Puedes proporcionar un nombre, descripción, URL de inicio de sesión y URL de redireccionamiento. Ten en cuenta que la URL de redireccionamiento debe ser relevante para tu proyecto.

• Después de completar los campos, haz clic en "Register Application" o "Crear aplicación", dependiendo de tu idioma.

• En la página de configuración de tu aplicación, encontrarás las dos variables de entorno necesarias:

  • GITHUB_CLIENT_ID: El ID del cliente de GitHub.
  • GITHUB_CLIENT_SECRET: El secreto del cliente de GitHub.

• Copia el valor de cada variable y pégalo en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  GITHUB_CLIENT_ID=YOUR_CLIENT_ID

  GITHUB_CLIENT_SECRET=YOUR_CLIENT_SECRET

Autenticación con Google:

• Visita https://console.developers.google.com/apis/credentials en tu navegador y asegúrate de iniciar sesión en tu cuenta de Google.

• Crea un nuevo proyecto o selecciona uno existente.

• Navega a la sección de "Credenciales" o "Credentials" en el panel de control del proyecto.

• Haz clic en "Crear credenciales" o "Create credentials" y selecciona "ID de cliente de OAuth" o "OAuth client ID".

• Completa los campos requeridos para tu cliente de OAuth. Asegúrate de configurar la URL de redireccionamiento adecuada para tu proyecto.

• Después de completar los campos, haz clic en "Crear" o "Create" para crear el cliente de OAuth.

• En la página de configuración del cliente de OAuth, encontrarás las dos variables de entorno necesarias:

  • GOOGLE_ID: El ID del cliente de Google.
  • GOOGLE_SECRET: El secreto del cliente de Google.

• Copia el valor de cada variable y pégalo en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  GOOGLE_ID=YOUR_GOOGLE_ID

  GOOGLE_SECRET=YOUR_GOOGLE_SECRET

Autenticación con Spotify:

• Visita https://developer.spotify.com/dashboard/applications en tu navegador y asegúrate de iniciar sesión en tu cuenta de Spotify o crear una cuenta nueva si aún no la tienes.

• Haz clic en "Crear una aplicación" o "Create an App" para crear una nueva aplicación en Spotify.

• Completa los campos requeridos para tu aplicación, como el nombre, descripción y URL de redireccionamiento. Asegúrate de que la URL de redireccionamiento sea relevante para tu proyecto.

• Una vez creada la aplicación, encontrarás las dos variables de entorno necesarias:

  • SPOTIFY_CLIENT_ID: El ID del cliente de Spotify.
  • SPOTIFY_CLIENT_SECRET: El secreto del cliente de Spotify.

• Copia el valor de cada variable y pégalo en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  SPOTIFY_CLIENT_ID=TU_CLIENT_ID_DE_SPOTIFY

  SPOTIFY_CLIENT_SECRET=TU_CLIENT_SECRET_DE_SPOTIFY

Cloudinary:

• Visita https://cloudinary.com en tu navegador y asegúrate de iniciar sesión en tu cuenta de Cloudinary o crear una cuenta nueva si aún no la tienes.

• Navega al panel de control de Cloudinary.

• Haz clic en tu nombre de usuario en la esquina superior derecha y selecciona "Cuenta" o "Account" en el menú desplegable.

• En la página de configuración de la cuenta, encontrarás la sección de "Detalles de la cuenta" o "Account Details". Aquí encontrarás las tres variables de entorno necesarias:

  • CLOUDINARY_CLOUD_NAME: El nombre de tu cuenta de Cloudinary.
  • CLOUDINARY_API_KEY: La clave de API de tu cuenta de Cloudinary.
  • CLOUDINARY_API_SECRET: El secreto de API de tu cuenta de Cloudinary.

• Copia el valor de cada variable y pégalo en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  CLOUDINARY_CLOUD_NAME=TU_NOMBRE_DE_CUENTA_CLOUDINARY

  CLOUDINARY_API_KEY=TU_CLAVE_DE_API_CLOUDINARY

  CLOUDINARY_API_SECRET=TU_SECRETO_DE_API_CLOUDINARY

Stripe:

• Visita https://dashboard.stripe.com en tu navegador y accede a tu cuenta de Stripe o crea una cuenta nueva si no tienes una.

• Una vez que hayas accedido, dirígete al panel de control de Stripe.

• En la barra lateral izquierda, haz clic en "Desarrolladores" y luego selecciona "Claves de API".

• En la página de Claves de API, encontrarás dos claves:

  • NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY: Esta es la clave de publicación utilizada en el lado del cliente.
  • STRIPE_SECRET_KEY: Esta es la clave secreta utilizada en el lado del servidor.

• Copia el valor de cada clave y configúralas como variables de entorno en tu entorno de desarrollo o en un archivo .env en el proyecto.

  Ejemplo de archivo .env:

  NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=TU_CLAVE_DE_PUBLICACIÓN

  STRIPE_SECRET_KEY=TU_CLAVE_SECRETA

NEXTAUTH_SECRET:

• Visita https://generate-secret.vercel.app/32 en tu navegador.

• En el sitio web, se generará automáticamente un secreto de 32 caracteres.

• Haz clic en el botón de copiar para copiar el secreto generado.

• Pega el secreto en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  NEXTAUTH_SECRET=TU_SECRETO_GENERADO

NodeMailer:

Para que Nodemailer funcione y pueda enviar correos electrónicos, necesitarás utilizar las credenciales de una cuenta de correo de Google. Sigue los siguientes pasos para obtener las credenciales necesarias:

• Abre un navegador web y visita la página de "Contraseñas de aplicaciones" de Google en https://myaccount.google.com/apppasswords.

• Inicia sesión en tu cuenta de Google si se te solicita.

• En la sección "Seleccionar aplicación" o "Select app", elige la aplicación para la cual deseas generar la contraseña. Si la aplicación no aparece en la lista, selecciona "Otra (personalizada)" o "Other (custom)".

• En la sección "Seleccionar dispositivo" o "Select device", elige el dispositivo desde el cual utilizarás la contraseña de aplicación. Si no aparece el dispositivo deseado, selecciona "Otro (personalizado)" o "Other (custom)".

• Haz clic en el botón "Generar" o "Generate".

• Google generará una contraseña de aplicación única. Copia esta contraseña y guárdala en un lugar seguro.

• Pega la contraseña en tu entorno de desarrollo o archivo .env en el proyecto.

  Ejemplo de archivo .env:

  GOOGLE_EMAIL=TU_GOOGLE_EMAIL

  GOOGLE_PASSWORD=TU_GOOGLE_PASSWORD

Base de Datos ( postgreSQL):

Agrega la siguiente línea al archivo `.env` para configurar la variable de entorno

Ejemplo de archivo .env: DATABASE_URL=postgresql://postgres:password@localhost:5432/digitaldreams?schema=public

Tu archivo debería verse así: 📄

BASE_URL="http://localhost:3000/"
GITHUB_CLIENT_ID=TU_CLIENT_ID
GITHUB_CLIENT_SECRET=TU_CLIENT_SECRET
GOOGLE_ID=TU_GOOGLE_ID
GOOGLE_SECRET=TU_GOOGLE_SECRET
SPOTIFY_CLIENT_ID=TU_CLIENT_ID_DE_SPOTIFY
SPOTIFY_CLIENT_SECRET=TU_CLIENT_SECRET_DE_SPOTIFY
CLOUDINARY_CLOUD_NAME=TU_NOMBRE_DE_CUENTA_CLOUDINARY
CLOUDINARY_API_KEY=TU_CLAVE_DE_API_CLOUDINARY
CLOUDINARY_API_SECRET=TU_SECRETO_DE_API_CLOUDINARY
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=TU_CLAVE_DE_PUBLICACIÓN
STRIPE_SECRET_KEY=TU_CLAVE_SECRETA
NEXTAUTH_SECRET=TU_SECRETO_GENERADO
GOOGLE_EMAIL=TU_GOOGLE_EMAIL
GOOGLE_PASSWORD=TU_GOOGLE_PASSWORD
DATABASE_URL=postgresql://postgres:password@localhost:5432/digitaldreams?schema=public

Ejecutar localmente 🏃‍♀️

Para ejecutar el proyecto localmente, sigue estos pasos:

• Abre una terminal en la raíz del proyecto.
• Ejecuta el siguiente comando para aplicar las migraciones de la base de datos:

  npx prisma migrate dev

• Luego, ejecuta el siguiente comando para iniciar el servidor de desarrollo:

  npm run dev

• Abre tu navegador web y ve a la URL http://localhost:3000. Ahora deberías poder ver y utilizar la aplicación localmente en tu navegador.

Ingresar datos en la aplicación 📝

• La aplicación no tiene datos inicialmente, por lo que existen dos formas de ingresar productos:

1. La primera forma es a través de la interfaz de usuario.
   • Dirígete a http://localhost:3000/auth/SignIn y regístrate.
   • Una vez registrado, inicia sesión. Al ser la primera cuenta registrada, tendrás el rol de "Admin". Con este rol, puedes ir a http://localhost:3000/dashboard y hacer clic en el botón "POST DATA".
   • Si ves una alerta de éxito en la parte izquierda de la pantalla que dice "all data in the app! refresh page to get data", puedes ir nuevamente a http://localhost:3000 y ver la aplicación funcionando correctamente.
2. La segunda forma es usando Postman o Thunder Client en Visual Studio Code.
   • Haz una solicitud de tipo POST a http://localhost:3000/api/data

Respuesta exitosa

Código: 200

Contenido: Objeto JSON

{
  "brands": 48,
  "categories": 16,
  "countries": 250,
  "subcategories": 34,
  "products": 830
}

Respuesta de error

Código: 400

Contenido: Objeto JSON

{
  "success": false,
  "message": "the data exists"
}

EN | Digital Dreams

The project is an e-commerce website that offers a variety of technology and computer-related products. The main objective of the project is to provide users with a convenient platform to purchase quality products online. The website will include features such as advanced search filters, third-party authentication, and a secure payment gateway.

With this e-commerce platform, customers will be able to explore various categories, perform specific searches, compare products, read reviews from other buyers, and make secure purchases. Additionally, a third-party authentication system will be provided to streamline the registration and login process.

In summary, the project aims to provide a convenient and secure online shopping experience for technology enthusiasts and those interested in computer-related products.

Available product categories: 💻

• Built Computers (Equipos armados)
• Consoles (Consolas)
• Notebooks (Portátiles)
• Cabinets (Gabinetes)
• Power Supplies and UPS (Fuentes de alimentación y UPS)
• Motherboards (Placas base)
• Processors (Procesadores)
• Cooling (Refrigeración)
• Memory (Memoria)
• Storage (Almacenamiento)
• Graphics Cards (Tarjetas gráficas)
• Peripherals (Periféricos)
• Monitors and TVs (Monitores y televisores)
• Chairs (Sillas)
• Pendrives (Memorias USB)
• Printers (Impresoras)

Technologies Used

List of the most relevant technologies used in this project:

Application Features

• Third-Party Authentication: Allows users to register and log in using their third-party accounts, such as Google or Facebook.
• Shopping Cart: Users can add products to the shopping cart, adjust quantities, and complete the checkout process.
• Reviews and Ratings: Users can leave reviews and ratings for products, helping other users make informed purchasing decisions.
• Favorites: Users can save products to their favorites list for easy access later.
• Payment Gateway: Integration of a payment gateway to enable secure transactions and complete the purchasing process.
• Filters and Sorting: Users can apply filters and sorting options to refine their product search in the store.
• Search Bar: Users can search for products using keywords and get relevant results.
• User Management: Functionality to manage and handle user information, such as profile editing, password changing, etc.
• Product Management: Allows administrators to add, edit, and delete products in the store's catalog.
• Reviews Management: Administrators can moderate and manage product reviews, including approving, deleting, or responding to them. It also includes a section for reporting bad comments.
• Dashboard and Analytics: Provides a control panel with visual charts and statistics to offer insights into sales performance, product analysis, etc.

Installation 🛠️

Follow these steps to install the "DigitalDreams" project using npm.

Clone the GitHub repository by executing the following command:

git clone https://github.com/JuniorHuanca/DigitalDreams.git

Navigate to the cloned project directory:

  cd DigitalDreams

Install the project dependencies:

  npm install

Environment Variables Configuration 📄

To run this project, you will need to add the following environment variables to your .env file:

GitHub Authentication:

• Visit https://github.com/settings/developers in your browser and make sure you are logged in to your GitHub account.

• Click on "New OAuth App" to create a new OAuth application.

• Fill in the required fields for your new application. You can provide a name, description, login URL, and redirect URL. Note that the redirect URL should be relevant to your project.

• After filling in the fields, click on "Register Application".

• On the application settings page, you will find the two required environment variables:

  • GITHUB_CLIENT_ID: The GitHub client ID.
  • GITHUB_CLIENT_SECRET: The GitHub client secret.

• Copy the value of each variable and paste it into your development environment or .env file in the project.

  Example .env file:

  GITHUB_CLIENT_ID=YOUR_CLIENT_ID

  GITHUB_CLIENT_SECRET=YOUR_CLIENT_SECRET

Google Authentication:

• Visit https://console.developers.google.com/apis/credentials in your browser and make sure you are logged in to your Google account.

• Create a new project or select an existing one.

• Navigate to the "Credentials" section in the project's dashboard.

• Click on "Create credentials" and select "OAuth client ID".

• Fill in the required fields for your OAuth client. Make sure to set the appropriate redirect URL for your project.

• After filling in the fields, click on "Create" to create the OAuth client.

• On the OAuth client settings page, you will find the two required environment variables:

  GOOGLE_ID: The Google client ID. GOOGLE_SECRET: The Google client secret.

• Copy the value of each variable and paste it into your development environment or .env file in the project.

  Example .env file:

  GOOGLE_ID=YOUR_GOOGLE_ID

  GOOGLE_SECRET=YOUR_GOOGLE_SECRET

Spotify Authentication:

• Visit https://developer.spotify.com/dashboard/applications in your browser and make sure to log in to your Spotify account or create a new account if you don't have one yet.

• Click on "Crear una aplicación" or "Create an App" to create a new application on Spotify.

• Fill in the required fields for your application, such as the name, description, and redirect URL. Make sure the redirect URL is relevant to your project.

• Once the application is created, you will find the two necessary environment variables:

  • SPOTIFY_CLIENT_ID: The Spotify client ID.
  • SPOTIFY_CLIENT_SECRET: The Spotify client secret.

• Copy the value of each variable and paste it into your development environment or .env file in the project.

  Example .env file:

  SPOTIFY_CLIENT_ID=YOUR_SPOTIFY_CLIENT_ID

  SPOTIFY_CLIENT_SECRET=YOUR_SPOTIFY_CLIENT_SECRET

Cloudinary:

• Visit https://cloudinary.com in your browser and make sure to log in to your Cloudinary account or create a new account if you don't have one yet.

• Navigate to the Cloudinary dashboard.

• Click on your username in the top-right corner and select "Account" or "Cuenta" from the dropdown menu.

• On the account settings page, you will find the "Account Details" or "Detalles de la cuenta" section. Here, you will find the three necessary environment variables:

  • CLOUDINARY_CLOUD_NAME: The name of your Cloudinary account.
  • CLOUDINARY_API_KEY: The API key of your Cloudinary account.
  • CLOUDINARY_API_SECRET: The API secret of your Cloudinary account.

• Copy the value of each variable and paste it into your development environment or .env file in the project.

  Example .env file:

  CLOUDINARY_CLOUD_NAME=YOUR_CLOUDINARY_ACCOUNT_NAME

  CLOUDINARY_API_KEY=YOUR_CLOUDINARY_API_KEY

  CLOUDINARY_API_SECRET=YOUR_CLOUDINARY_API_SECRET

Stripe:

• Visit https://dashboard.stripe.com in your browser and log in to your Stripe account or create a new account if you don't have one.

• Once you have logged in, navigate to the Stripe dashboard.

• In the left sidebar, click on "Developers" and then select "API Keys".

• On the API Keys page, you will find two keys:

  • NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY: This is the publishable key used on the client-side.
  • STRIPE_SECRET_KEY: This is the secret key used on the server-side.

• Copy the value of each key and set them as environment variables in your development environment or in a .env file in your project.

  Example .env file:

  NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY

  STRIPE_SECRET_KEY=YOUR_SECRET_KEY

NEXTAUTH_SECRET:

• Visit https://generate-secret.vercel.app/32 in your browser.

• On the website, a 32-character secret will be automatically generated.

• Click on the copy button to copy the generated secret.

• Paste the secret into your development environment or .env file in your project.

  Example .env file:

  NEXTAUTH_SECRET=YOUR_GENERATED_SECRET

NodeMailer:

In order for Nodemailer to work and send emails, you will need to use the credentials from a Google email account. Follow these steps to obtain the necessary credentials:

• Open a web browser and visit the "App passwords" page of Google at https://myaccount.google.com/apppasswords.

• Sign in to your Google account if prompted.

• In the "Select app" section, choose the application for which you want to generate the app password. If the application doesn't appear in the list, select "Other (custom)".

• In the "Select device" section, choose the device from which you will use the app password. If the desired device doesn't appear, select "Other (custom)".

• Click the "Generate" button.

• Google will generate a unique app password. Copy this password and keep it in a secure place.

• Paste the password into your development environment or .env file in your project.

  Example .env file:

  GOOGLE_EMAIL=YOUR_GOOGLE_EMAIL

  GOOGLE_PASSWORD=YOUR_GOOGLE_PASSWORD

Database (PostgreSQL):

Add the following line to the .env file to configure the environment variable.

Example .env file: DATABASE_URL=postgresql://postgres:password@localhost:5432/digitaldreams?schema=public

Traducción:

Base de datos (PostgreSQL): Agrega la siguiente línea al archivo .env para configurar la variable de entorno.

Ejemplo de archivo .env: DATABASE_URL=postgresql://postgres:password@localhost:5432/digitaldreams?schema=public

Your file should look like this: 🏃‍♀️

BASE_URL="http://localhost:3000/"
GITHUB_CLIENT_ID=YOUR_CLIENT_ID
GITHUB_CLIENT_SECRET=YOUR_CLIENT_SECRET
GOOGLE_ID=YOUR_GOOGLE_ID
GOOGLE_SECRET=YOUR_GOOGLE_SECRET
SPOTIFY_CLIENT_ID=YOUR_SPOTIFY_CLIENT_ID
SPOTIFY_CLIENT_SECRET=YOUR_SPOTIFY_CLIENT_SECRET
CLOUDINARY_CLOUD_NAME=YOUR_CLOUDINARY_ACCOUNT_NAME
CLOUDINARY_API_KEY=YOUR_CLOUDINARY_API_KEY
CLOUDINARY_API_SECRET=YOUR_CLOUDINARY_API_SECRET
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY
STRIPE_SECRET_KEY=YOUR_SECRET_KEY
NEXTAUTH_SECRET=YOUR_GENERATED_SECRET
GOOGLE_EMAIL=YOUR_GOOGLE_EMAIL
GOOGLE_PASSWORD=YOUR_GOOGLE_PASSWORD
DATABASE_URL=postgresql://postgres:password@localhost:5432/digitaldreams?schema=public

Run Locally 📝

To run the project locally, follow these steps:

• Open a terminal in the project's root directory.
• Run the following command to apply the database migrations:

npx prisma migrate dev

• Then, run the following command to start the development server:

npm run dev

• Open your web browser and go to the URL http://localhost:3000. You should now be able to view and use the application locally in your browser.

Enter data in the application

• The application doesn't have any initial data, so there are two ways to add products:

1. The first way is through the user interface.

   • Go to http://localhost:3000/auth/SignIn and sign up.
   • Once registered, log in. Being the first registered account, you will have the "Admin" role. With this role, you can go to http://localhost:3000/dashboard and click on the "POST DATA" button.
   • If you see a success alert on the left side of the screen saying "all data in the app! refresh page to get data," you can go back to http://localhost:3000 and see the application working correctly.

2. The second way is by using Postman or Thunder Client in Visual Studio Code.

   • Make a POST request to http://localhost:3000/api/data

Successful response

Code: 200

Content: JSON object

{
  "brands": 48,
  "categories": 16,
  "countries": 250,
  "subcategories": 34,
  "products": 830
}

Error response

Code: 400

Content: JSON object

{
  "success": false,
  "message": "the data exists"
}

API Reference

Overview

The API reference provides detailed information on how to interact with our API endpoints. It includes the endpoint structure, supported parameters, HTTP methods, and expected responses. Use this documentation to understand our API.

Base URL

All API endpoints are accessed via the following base URL:

  http://localhost:3000

Endpoints

Products

• GET all products

  GET /api/products

Parameter	Type	Description
none	none	You get all the products in the store

• GET all products recommended

  GET /api/products?recommended=true

Parameter	Type	Description
none	none	You get all the recommended products

• GET all products by brand

  GET /api/products?brand=${brand}

Parameter	Type	Description
brand	string	Required. brand of item to fetch

• GET one product of each brand

  GET /api/products?brands=true

Parameter	Type	Description
none	none	You get a product of each brand

• GET all the best selling products

  GET /api/products?mostSelling=true

Parameter	Type	Description
none	none	You get all the best selling products

• GET all related products

  GET /api/products?related=${name}&id=${id}

Parameter	Type	Description
name	string	Required. element name to search for its related
id	string	Required. id of the element to not bring the same

• GET all the products of the category

  GET /api/products?category=${category}

Parameter	Type	Description
category	string	Required. category of item to fetch

Product

• GET product by id

  GET /api/products/${id}

Parameter	Type	Description
id	string	Required. id of item to fetch

Users

• GET all users

  GET /api/users

Parameter	Type	Description
none	none	You get all the products in the app

• GET user by email

  GET /api/user?email=${email}

Parameter	Type	Description
email	string	You get the user

Data

• GET data

  GET /api/data

Parameter	Type	Description
none	none	You get all data in the app

• GET brands data

  GET /api/data?brandsQ=true

Parameter	Type	Description
none	none	You get all brands in the app

• GET categories data

  GET /api/data?categoriesQ=true

Parameter	Type	Description
none	none	You get all categories in the app

• GET subcategories data

  GET /api/data?subcategoriesQ=true

Parameter	Type	Description
none	none	You get all subcategories in the app

Reviews

• GET product reviews

  GET /api/review?productId=${productId}

Parameter	Type	Description
productId	string	Required. id of item to fetch

• GET user reviews

  GET /api/review?userId=${userId}

Parameter	Type	Description
userId	string	Required. id of item to fetch

Favorites

• GET user favorites

  GET /api/favorite?userId=${userId}

Parameter	Type	Description
userId	string	Required. id of item to fetch

• GET user favorite

  GET /api/favorite?userId=${userId}&productId=${productId}

Parameter	Type	Description
userId	string	Required. id of item to fetch
productId	string	Required. id of item to fetch

Demo

https://digitaldreams.vercel.app

Author

• @Junior Huanca

Connect with me