Pency

Tu tienda online, fácil.

Qué es?

Pency es una tienda online multipropósito, pensada para quienes venden (o quieren vender) vía WhatsApp.

Qué tiene?

• Catálogo online
• Panel de administración para cargar productos
• Carrito de compra
• Imagen, precio y descripción para cada producto
• Opciones para cada producto (pueden modificar el precio del producto)
• Envío del pedido vía WhatsApp
• Configuración de la tienda (color, título, descripción, imagen, logo, etc)

Algo no me anda!

Podés crear un issue acá en GitHub.

Quiero ayudar!

Entrá a los issues acá en GitHub

Quiero mi tienda!

Mandame un mail a [email protected]

Tengo otra pregunta

Mandame un mail a [email protected]

¿Cómo puedo correr el proyecto?

Completá todas las variables que aparecen en .env.template y guardalo como .env.development.local

Todas las variables de firebase las encontramos en la configuración del proyecto de firebase, GOOGLE_API_KEY es la api key de firebase, pero como también necesitamos usarla para Google Places le cambié el nombre, tomá en cuenta que para que funcione el campo de ubicación necesitás tener la api de places habilitada en el proyecto y billing activado (o podés no usar el campo / deshabilitarlo, la app funciona sin eso).

En firebase/credentials.ts están las credenciales de firebase admin para cada ambiente, necesitás obtener el json de una cuenta de servicio que podés encontrar en firebase yendo a Configuración > Usuarios y permisos > Cuentas de servicio y generando una nueva clave privada. Después andá a https://www.devglan.com/online-tools/aes-encryption-decryption y seleccioná tu archivo de credenciales, en mode seleccioná CBC, Key Size in Bits 128, Enter IV (Optional) la misma clave iv que en tu archivo .env.development.local, Enter Secret Key la misma secret key que en tu archivo .env.development.local, Output Text Format en Base64, clickea Encrypt y pegá el contenido en firebase/credentials.ts en el ambiente que corresponda.

Luego en consola ejecutá:

# Yarn
yarn
yarn start

# O si usas npm
npm install
npm start

Necesitás tener un .env.[ambiente].local para cada ambiente en el que vas a correr la app.

¿Cómo correr Storybook?

Storybook nos permite observar los distintos componentes visuales utilizados en el proyecto en un ambiente aislado.

Ejecutá en la consola los siguientes comandos para abrir Storybook:

# Yarn
yarn storybook

# O si usas npm
npm run storybook

Configurando Firebase

1. Accedé a Firebase.
2. Creá un nuevo proyecto.
3. Habilitá el inicio de sesión con correo electrónico y contraseña desde Desarrollo > Authentication > Sign-in method.
4. Andá a Configuración > General y en el apartado "Tus apps" agregá una nueva app web. Al cliquear en "Registrar" te va a aparecer un código HTML con la configuración que necesitamos en una var "firebaseConfig".
5. Completá con esos datos las variables del .env.development.local relacionadas a Firebase.

Configurando MongoDB

1. Logueate a MongoDB o create una cuenta si hace falta: https://www.mongodb.com/cloud/atlas/register
2. Creá una organización si no tenés ninguna,te sugerimos usar el servicio Cloud Atlas.
3. Ahora creá un nuevo proyecto para tu tienda.
4. Creá un cluster, con la versión free estamos bien.
5. Una vez listo el cluster configurá cómo te vas a conectar cliqueando en "Connect" y elegí "Connect your application" como método de conexión.
6. Creá un usuario y contraseña y guardá estos datos que los vas a necesitar después.
7. También copiá la URL de conexión.
8. Ahora creá una BD. Andá a tu cluster > Collections y cliqueá en "Add my Own data" (si es tu primera BD) o en "Add database" si ya tenés otras BBDD.
9. Elegí un nombre para tu BD y creá la collection "tenants".
10. Ahora que ya tenemos todos los datos que necesitamos completamos el .env.development.local. En <DB_URL> poné la URL de conexión reemplazando el usuario, contraseña y nombre de la BD y en <DB_NAME> poné el nombre de la BD.

Configurando Cloudinary

También vamos a necesitar una cuenta en Cloudinary para alojar las imágenes de la tienda. De allí vamos a necesitar el Cloudinary Cloud name para la variable CLOUDINARY_CLOUD del environment (lo vas a ver arriba a la derecha una vez que inicies sesión). Además vamos a tener que ir a Settings > Upload donde podemos configurar los presets. El CLOUDINARY_PRESET_LOW se va a usar para las imágenes de los productos cargados y CLOUDINARY_PRESET_HIGH para las imágenes de banner y logo. Tenemos que asegurarnos de setear el Signing Mode en Unsigned, el resto de las configuraciones depende de tus preferencias. También vamos a setear la variable CLOUDINARY_FOLDER con el nombre de la carpeta donde queremos que se guarden las imágenes dentro de cloudinary, "pency", por ejemplo.

Configurando el proyecto

Una vez que tengamos nuestro .env.[ambiente].local listo, vamos a la consola, nos paramos en la carpeta de nuestro proyecto y ejecutamos:

# yarn
yarn && yarn dev

# o si usas npm
npm install && npm run dev

Creando la tienda

• Bajamos y abrimos Postman.
• Comprobamos que la aplicación este corriendo en http://localhost:3000/.
• Seleccionamos POST Request y colocamos como URL: http://localhost:3000/api/tenant/NOMBRE_DE_TU_TIENDA (si bien podemos poner lo que queramos en slug recomiendo que sean solo letras minúsculas y guiones)
• En body seleccionamos x-www-form-urlencoded y colocamos los siguientes valores:

	|   KEY  |                    VALUE                         |
	|:------:|:------------------------------------------------:|
	|email   | [email protected]                                |
	|password| tuContraseña                                     |
	|secret  | valor de SECRET en .env.[ambiente].local         |

• Hacemos click en Send y comprobamos si se creó la tienda entrando en: http://localhost:3000/NOMBRE_DE_TU_TIENDA
• Para acceder al panel de administración debemos entrar mediante el siguiente link: http://localhost:3000/NOMBRE_DE_TU_TIENDA/admin

Tomá en cuenta que ya que usamos el uid del usuario como id del documento, no podémos tener más de un usuario por tienda ni tampoco más de una tienda por usuario.

Primer deploy a Vercel

Buildeamos la tienda de /demo y las tiendas de /index estáticamente, por lo que necesitamos que la app ya este deployada en Vercel. Claramente no es posible si querés deployarla la primera vez y va a fallar el build en Vercel. Así que recorda comentar / borrar el getStaticProps para pages/index.tsx y pages/demo.tsx antes de deployar la primera vez (después podés volver a habilitarlo si te sirven).

¿Qué puedo hacer con Pency?

Podés leer la licencia acá. En resumen, podés usar Pency para lo que quieras mientras no lucres con eso y menciones la fuente original cuando lo uses 🥰.