markdown zen

MarkdownZen

MarkdownZen es una aplicación web diseñada para agilizar la creación y gestión de documentos de rebajas. Con una interfaz fácil de usar y funciones potentes, MarkdownZen es su herramienta de referencia para una experiencia de rebajas zen.

Tabla de contenido

• Empezando
  • Requisitos previos
  • Instalación
• Uso
• Características
• Ejecutando con Docker
• Contribuyendo
• Licencia

Empezando

Requisitos previos

Antes de comenzar, asegúrese de tener el siguiente software instalado en su computadora:

• Nodo.js
• npm (Administrador de paquetes de nodos)

Instalación

1. Clonar el repositorio :

   Abra su terminal/símbolo del sistema y navegue hasta la ubicación donde desea almacenar el proyecto. Luego, ejecute el siguiente comando:

git clone https://github.com/daniel752/markdown-zen.git

Esto descargará los archivos del proyecto a su computadora.

2. Navegue a la carpeta del proyecto :

Utilice el comando cd para cambiar su directorio de trabajo a la carpeta del proyecto clonado:

cd markdown-zen

3. Instalar dependencias :

Dentro de la carpeta del proyecto, instale las dependencias necesarias tanto para el servidor como para el cliente usando un solo comando:

npm run setup-project

Esto instalará los paquetes necesarios para los componentes del servidor y del cliente de la aplicación.

Uso

1. Inicie la aplicación :

Para iniciar la aplicación, ejecute el siguiente comando en la carpeta raíz (markdown-zen/):

npm run dev

Este comando inicia tanto el servidor como el cliente simultáneamente, para que pueda acceder a la aplicación en su navegador.

2. Accede a la aplicación :

Abra su navegador web y vaya a http://localhost:5173 . Aquí es donde encontrarás la aplicación MarkdownZen.

3. Creación y gestión de rebajas :

• Inicia sesión o crea una cuenta.
• Comience a crear y administrar sus documentos de rebajas sin esfuerzo.

Características

• Cree, edite y administre documentos de rebajas con facilidad.
• Vista previa de rebajas en tiempo real durante la edición.
• Organice las rebajas utilizando categorías y etiquetas.
• Sistema seguro de autenticación y autorización.
• ...

Ejecutando con Docker

También puedes ejecutar MarkdownZen usando Docker. Siga estos pasos:

1. Extraiga la imagen de Docker :

   Extraiga la imagen de MarkdownZen Docker desde Docker Hub:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Ejecute el contenedor :

   Inicie el contenedor MarkdownZen:

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: ejecuta el contenedor en modo independiente (en segundo plano).
• El contenedor operará en el puerto 8000 en el interior y en el 5173 en el exterior.

Contribuyendo

¡Agradecemos las contribuciones de la comunidad! Para contribuir a MarkdownZen, siga estos pasos:

1. Bifurcar el repositorio :

Haga clic en el botón "Bifurcación" en la parte superior derecha de la página del repositorio de GitHub. Esto crea una copia del repositorio en su cuenta de GitHub.

2. Clona tu bifurcación :

Clona tu repositorio bifurcado en tu máquina local:

git clone https://github.com/your-username/markdown-zen.git

3. Crear una nueva sucursal :

Cambie al directorio del proyecto:

cd markdown-zen

Crea una nueva rama para tu función:

git checkout -b feature/my-new-feature

4. Hacer cambios :

Realice los cambios necesarios y confírmelos:

git commit -m 'Add some feature'

5. Impulsa tus cambios :

Envía tus cambios a tu repositorio bifurcado:

git push origin feature/my-new-feature

6. Enviar una solicitud de extracción :

Visite el repositorio original en GitHub y haga clic en el botón "Nueva solicitud de extracción" para enviar sus cambios para su revisión.

Licencia

Este proyecto está bajo la licencia MIT. Consulte el archivo de LICENCIA para obtener más detalles.