Skip to content

Archivo de tweets de El Salvador marcados utilizando @tweet_stamp

Notifications You must be signed in to change notification settings

ricardoerl/svstamp

Repository files navigation

svstamp

coverage badge

Código fuente de svtamp.com, un archivo de tweets de El Salvador marcados utilizando @tweet_stamp @tweet_stamp. El proyecto utiliza Next.js, TypeScript, MongoDB y Tailwind CSS.

Cómo contribuir

Con sugerencias o reportar un problema

Gracias por el interés en ayudar con el proyecto. Para compartir tu sugerencia o reporte puedes crear un issue con la mayor cantidad de información posible para que luego alguien lo pueda pueda revisar. Por favor revisar antes otros issues para evitar duplicados.

Con código o documentación

Toda ayuda con código o documentación es bienvenida. Puedes revisar el Roadmap actual o cualquiera de los issues abiertos. Si es una sugerencia nueva o cambio importante, abre primero un issue para discutir el cambio.

Instalación

Para clonar y ejecutar el proyecto se necesita Git y Node.js (12+) instalados en tu computadora.

Luego en la carpeta del proyecto:

# Instalar dependencias
$ npm install

# Ejecutar la aplicación en desarrollo
$ npm run dev

# Ejecutar pruebas unitarias
$ npm run test

# Ejecutar pruebas unitarias con watch mode
$ npm run test:watch

Ahora deberías poder ver la aplicación ejecutándose en http://localhost:3000/

Nota: Es necesario renombrar el archivo .env.example a .env. Las credenciales por el momento son de prueba y tiene limitantes, cualquier problema por favor reportarlo.

Nota: Es requerido ejecutar exitosamente todas las pruebas unitarias antes de contribuir con un cambio. Cada cambio debe llevar pruebas unitarias (si aplica).

Probar el proyecto en modo producción
# Construir la aplicación en producción
$ npm run build

# Ejecutar la aplicación en producción en servidor local
$ npm run start

Roadmap

  • Mostrar cuadrícula de tweets de la base de datos
  • Guardar y validar nuevos tweets
  • Agregar página de condiciones y término de uso
  • Soporta filtros básicos (autor)
  • Optimizar la integración de tailwindcss
  • Agregar cómo contribuir
  • Agregar soporte de paginación
  • Agregar soporte swr
  • Agregar soporte de MirageJS
  • Agregar soporte de TypeScript
  • Agregar cobertura de testing
  • Soporta filtros avanzados (fecha, texto)

Licencia

MIT License

Copyright (c) 2020 Ricardo Ramírez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Archivo de tweets de El Salvador marcados utilizando @tweet_stamp

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •