quickjots

Ráfano

QuickJots es una aplicación web para anotar y ahorrar automáticamente cualquier nota rápida en su navegador, usando Markdown o simple texto. No se necesita registro, ¡y hay un modo oscuro disponible!

Se admiten las notas de texto sin formato y markdown (con la ayuda de Showdown).

Este repositorio contiene todo el código fuente para la aplicación web en QuickJots.App.

QuickJots se aloja actualmente usando NetLify, por lo que también hay un archivo netlify.toml en la raíz para configurar Netlify.

Empezando

Si desea contribuir a QuickJots, o alojarlo usted mismo, deberá desembolsar este repositorio a través de GitHub, seguido de:

QuickJots usa Bundly Webpack el código fuente en este repositorio juntos en un sitio estático. Utiliza un trabajador de servicios para proporcionar soporte fuera de línea.

El código JavaScript principal está en ./src/js : todos los archivos usan el objeto Base window.quickjots y agregan las funciones y variables necesarias a esto.

1. git clone [email protected]:[username]/quickjots.git
2. Asegúrese de tener Node.js instalado (para agrupar los archivos con Webpack)
3. Ejecute yarn install en el directorio de repositorio de raíz para instalar las dependencias
4. Ejecute yarn start para ejecutar el servidor de desarrollo webpack en su puerto local 8080 mientras modifica el código. Se volverá automáticamente en cualquier cambio
5. Ejecute yarn build para ejecutar Webpack en modo de producción para generar archivos en dist/ . Estos archivos contienen el sitio estático, para que usted se aloje si lo desea

Tenga en cuenta que es posible que desee deshabilitar al trabajador de servicio en modo de desarrollo si está probando muchos cambios localmente, de lo contrario verá que el código antiguo funciona en lugar de su nuevo código! También hay una opción 'Actualización sobre la recarga' en las herramientas de desarrollo de Chrome para trabajadores de servicios si no desea deshabilitarla para el modo Dev.

Que contribuye

¡Cualquier contribución como informes de errores, solicitudes de funciones o solicitudes de extracción es bienvenida!

Hay una configuración de Eslint en .eslintrc.json , pero en resumen el estilo de código principal es:

• Use la sangría de 2 espacios
• Use espacios para la sangría
• Use semicolones al final de las declaraciones
• Use funciones de flecha siempre que sea posible