afdezcl/kemenu

kemenu

Kemenu web application, for menu management written in Java and Angular.

Roadmap

1. Monetization
2. SEO
3. Admin panels
4. Home redesign
5. /show customization
6. Contact form

Server

• Vendor: OVH
• Expenses: 15.71 € / month.
• Spec:
  • CPU: 2 vCores
  • RAM: 8 GB
  • Storage: 80 GB

IMPORTANT:exclamation:: Use npm as follows

⚠️ Before running the frontend you have to compile the frontend:

mvn -U clean install -pl :kemenu-frontend

1. Hot reloading to work with frontend:

bash kemenu-frontend/npm --prefix kemenu-frontend run start

2. For use ng command:

bash kemenu-frontend/npm --prefix kemenu-frontend run ng <NG_COMMAND>

3. For install a npm package:

bash kemenu-frontend/npm --prefix kemenu-frontend install <PACKAGE>

Build project

1. Build entire project

mvn -U clean install -pl :kemenu-frontend && mvn -U clean test package -pl :kemenu-backend

2. Compile frontend

mvn -U clean install -pl :kemenu-frontend

3. Compile backend

mvn -U clean test package -pl :kemenu-backend

4. Launch acceptance tests

mvn -U clean test -pl :kemenu-acceptance-tests

5. How to launch docker

docker-compose up

How to run backend in local with Intellij IDEA

⚠️ Before running the backend, you need to have the docker running with mongodb.

1. Go to kemenu-backend/src/main/java/com/kemenu/kemenu_backend/Application.java
2. Right click and click on Debug 'Application'
3. Stop it
4. Go to Run > Edit Configurations...
5. In the new window select Spring Boot > Application > Environment
6. Put in VM options the following -Dspring.profiles.active=dev
7. Click on Apply and then in OK

Stack

• Angular 9 + Bootstrap
• Java 15 + Spring Boot
• MongoDB
• Docker

Branch naming convention

A branch must be named following this convention:

• Start with KEM-[ISSUE_NUMBER]_[SHORT_DESCRIPTION]
• For example: KEM-9_login_page

kemenu's Issues

Hacer acceptance tests para flujos principales

• Login + Crear menu (creando sección, plato) + ver menú en show

Create profile component to allow users change password and business name

Menú del día PRIMERO, SEGUNDO, TERCERO, etc

• Cambio de precio si pones papas o arroz.
• Cambio de precio si quitas SEGUNDO y solo tomas el menu del dia con PRIMERO y POSTRE

Allow users to change password

Add button to the show menu to allow user to do the order via phone

Update API to allow create more than one menu

Allow users to upload a photo for each dish

Add recaptcha to register endpoint

Create lazy loading for angular modules

Add allergens API to create allergens in the system

This ticket should be after the first admin panel

API for add a photo for dish

Create business info field to put additional info about the business

Create OCR web service

Add registration email verification with sendgrid

Icons from FontAwesome not working on production mode

Add again linter and unit tests to frontend pom.xml

API for add contact phone for the business

Porciones (raciones, tapas, trozos de pizzas, tostadas, etc...)

Crear customer demo y borrar el mock demo que tenemos en frontend

Eliminar /demo de las páginas de la web y crear un usuario que cuando pulses en el botón demo vaya al /show de ese usuario.

Porciones (raciones, tapas, trozos de pizzas, etc...)

Change to reCaptcha v2 [BE]

Create component to allow users to change business name

Allow user to choose menu primary color

Darle la opción al usuario que ve el menú en /show para darle a "Que me gusta" al plato

Habría que hacer de alguna forma que un usuario solo pueda darle a me gusta una única vez y que no tenga que estar registrado.

Nota:

• Podemos cambiar el "Me gusta" por un 'rating' de 5 estrellas https://valor-software.com/ngx-bootstrap/#/rating
• Podemos usar esta libreria https://github.com/Valve/fingerprintjs2
• Añadir a los restaurantes la opción en Profile para desactivar los likes o activarlos.

Crear FAQ con los textos en un desplegable sobre el footer

¿Cuántas veces puedo modificar mi menú?
Puedes modificar el menú tantas veces quieras, es decir, puedes añadir, editar o eliminar las secciones de la carta y los platos de cada una de ellas todas las veces que necesites. No existe ningún límite de modificaciones del menú.

¿Cómo obtengo el código QR?
Para poder obtener el código QR de su restaurante necesita registrarse con sus datos e iniciar sesión. Acto seguido podrá iniciar sesión y comenzar a crear su menú digital o subir una imagen de la carta. En este momento KEMENU te proporcionará el código QR que podrás guardar e imprimir para dejarlo por su restaurante.

¿Cuánto tiempo dura el código QR?
El código QR es de por vida, es decir, no tiene fecha de caducidad.

¿Si modifico el menú cambia el código QR?
Puedes modificar el menú todas las veces que necesites y el código QR será el mismo, por lo que si ya tienes el código impreso y repartido por el restaurante, no te preocupes porque el código QR seguirá siendo el mismo aunque cambies la carta.

¿Puedo subir una imagen de la carta de mi restaurante?
Desde KEMENU ofrecemos la posibilidad de hacer el menú digital (dónde tendrás que introducir cada sección y plato de tu carta), pero también puedes subir una imagen de la carta para el mismo código QR.

¿Cómo pueden ver los clientes la carta en su móvil?
Cuando tengas el código QR repartido por tu restaurante, los clientes solo tendrán que abrir la cámara de su móvil y enfocar al código QR, acto seguido les aparecerá un enlace con la carta de tu restaurante. Si no funcionase con la cámara del móvil, recomendamos descargar alguna aplicación gratuita de lector de QR, ya que móviles de años anteriores no permiten leer el código QR directamente desde la cámara.

Change to reCaptcha v2 [FE]

Soporte para más de una currency

1. Añadir a la API un endpoint que te devuelva todas las currencies.
2. Añadir en el formulario de registro un nuevo campo que sea un selector de currency.
3. Añadir a nivel de API Menu response el currency ya formateado con símbolo formateado

New home view

Create abous us page

Create Admin components to show information from de admin API

• Create a table component
• Create the admin integration

Allow users to modify business name

Whitelabel Error Page

If you type an URL like https://kemenu.com/register appear an error:
This application has no explicit mapping for /error, so you are seeing this as a fallback.

Cookie size is too big

We should reduce the size of the cookie when a user is looking at a menu.

Possible new feature to sections order

There is a possible new feature when a business creates a section he must order them as drag-drop for example.

Añadir selector de currencies en menu

Añadir también las traducciones de los nombres de las currencies

Check font color red over white/gray is hard to read

When a user try to read a menu it's should read it easily, try to change the font colors of this section.

Actualizar API para crear menús con primero, segundo y tercero

• Habrá un modelo nuevo que sea "DailyMenu" que tenga este comportamiento.

Add forgot password logic

This should be a GET to the backend first the backend validates if the email exists and then send an email to the user.

Add refresh endpoint

Add tooltip to allergens when show to the public users

Add recaptcha to register form

Fix app alert position

After agreement with Nico, change the position for the alert after login/register.

Add forgot password in login modal

This should be a link that redirects you to a form to fill with your email.

Add comma for decimals when is comma separated currency

Dar opción para descargar un menú ya hecho en pdf

Remove Menu word from hamburguer menu button

Keep only the three lines

https://imgur.com/a/TAk3Xio

Create Admin API to see all customers in the system

Allow users to upload a business photo

Integrate cloudinary to store images

Allow users change his business photo in profile component

API add business info

Additional info for the business, for example: When to do a table booking