BathWorld 🚽

Permite al usuario ubicar y calificar los mejores y más cercanos baños publicos en la ciudad de Colima.

Índice

• Instalación
• Entornos
• Característcas
• Contribuciones

Echa un vistazo 🚀

Instalación 🛠️

1. Clona el repositorio

   git clone git@github.com:Branyoe/BathWorld.git
   cd BarhWorld

Entornos ⚙️

Desarrollo local

1. Instala las dependencias.

   npm install --legacy-peer-deps

2. Crea una copia del archivo ".example.env.dev" llamada ".env" y sustituye los ejemplos por tus variables.

3. Ejecuta el servidor de desarrollo.

   npm start

4. Accede al servidor de desarrollo desde http://localhost:{puerto configurado}

Desarrollo con Docker 🐋

1. Asegurate de que el servicio de docker esté activo.

2. Crea una copia del archivo ".example.env.dev" llamada ".env.dev" y sustituye los ejemplos por tus variables.

3. Ejectua el servidor de desarrollo con docker.

   npm run dev-srv

4. Accede al servidor de desarrollo desde http://localhost:{puerto configurado}

Producción con Docker 🐋

1. Asegurate de que el servicio de docker esté activo.

2. Crea una copia del archivo ".example.env.prod" llamada ".env.prod" y sustituye los ejemplos por tus variables.

3. Ejecuta el servidor de producción.

   npm run prod-srv

4. [OPCIONAL] Monitorea el servidor

   docker exec -it app-prod sh

   despues, ya dentro de la consola del contendor

   pm2 monit

5. Accede al servidor de producción desde http://localhost:{puerto configurado}

6. [NOTA] El servidor de producción no reconoce cambios en el codigo fuente, para ver los cambios aplicados ejecuta el siguiente comando.

   npm run prod-srv-rebuild

Características ✨

• Autenticación de usuario.
• Integración con Mapbox.
• Trazado de rutas.
• Tutorial para el usuario.

Contribuciones 🤝

Agradecemos las contribuciones. Para contribuir al proyecto, sigue estos pasos:

Fork el proyecto:

1. Crea una nueva rama (git checkout -b feature/nueva-caracteristica).
2. Commit tus cambios (git commit -m 'Añadir nueva característica').
3. Push a la rama (git push origin feature/nueva-caracteristica).
4. Abre un pull request. Por favor, asegúrate de seguir nuestras pautas de contribución.