elliotforwater.com

Elliot para agua - frontend

Elliot for Water es el motor de búsqueda que dona agua con sus búsquedas: https://elliotforwater.com

Elliot for Water es una empresa social, con la misión de proporcionar a millones de personas acceso a agua potable segura. En la práctica, Elliot for Water es como cualquier otro motor de búsqueda, pero con la característica adicional de que donamos el 60% de nuestras ganancias para obtener proyectos de agua limpia.

Somos un equipo muy pequeño que trabajamos incesantemente en Elliotforwater para que se convierta en una realidad que puede ayudar a millones de personas. Para hacerlo, necesitamos desarrollar más funcionalidades que permitan que el proyecto se mueva más rápido y entregue un producto que a nuestros usuarios les encantará usar. Si está considerando contribuir, hay muchas cosas que podría obtener de este proyecto: podría trabajar en un proyecto que realmente ayude a las personas necesitadas y marque la diferencia en el mundo. Trabajará con tecnologías modernas y tendrá espacio para trabajar en tareas de tamaño mediano, lo que en realidad marcará la diferencia y tendrá su signo una vez en producción. Y trabajará con un equipo joven y de mente abierta emocionado de intercambiar ideas y obtener nuevas aportes.

Versiones del sistema

Nodo 14

NPM 6.14.11

nextjs 10

Estado de construcción

Rama	Estado
principal
desarrollar

Documentación

Please find all the project related information in the Wiki Quick links: Project set up and usage: https://github.com/ElliotForWater/elliotforwater.com/wiki/1.-Set-up-and-usage How to contribute: https://github.com/ElliotForWater/elliotforwater.com/wiki/3.-How-to-contribute Our code standard: https://github.com/elliotforwater/elliotforwater.com/wiki/7.-code-styleguide

Cómo empezar

Este proyecto está construido con Reactjs , Nextjs , Typescript , Storybook y Jest . Para ejecutar el proyecto, debe instalar en su máquina:

• Nodejs > 8
• npm

Una vez que clona el repositorio, continúe e instale todos los paquetes:

• npm i debo correr desde root
• npm run dev para ejecutarse en entorno de desarrollo
• npm run build para ejecutar la compilación del proyecto y verificar los errores
• npm run storybook para ejecutar Storybook y echar un vistazo a los componentes de la interfaz de usuario
• npm run test para ejecutar cobertura de prueba

Eche un vistazo a package.json para descubrir más scripts que puede ejecutar.

API y conexión de backend

Este proyecto es el código frontend de Elliotforwater. Para completar los resultados de búsqueda, tenemos que usar una API interna que se mantiene en un repositorio diferente, que no es de código abierto. (Estamos considerando la fuente abierta también, pero necesitamos investigar las implicaciones legales de la misma). Nuestra API se ejecuta en el entorno de puesta en escena y producción. Para el desarrollo del desarrollo, también puede usar el entorno de puesta en escena. Encontrará comentarios explicativos en el archivo .env.staging .

¡Quiero ayudar! ¿Cómo puedo empezar?

Siempre damos la bienvenida al contribuyente de cualquier tipo. Puede apoyarnos en el código de escritura, probar, escribir traducción, dar consejos sobre UI, UX, SEO o detectar errores o solicitar nuevas funciones. En nuestros problemas de GitHub, encontrará diferentes tareas que en su mayoría necesitan ayuda. Eres más que bienvenido a tomar cualquiera de esas tareas y trabajar en ellas. Asigne la tarea en la que desea trabajar para usted mismo, comunique al equipo cualquier duda, inquietud, especificaciones poco claras o ideas de mejoras.

¡Siempre damos la bienvenida a los nuevos comentarios! Si tiene alguna idea sobre cómo mejorar el proyecto, no dude en abrir un problema, etiquetar con ideas y lo verificaremos y responderemos lo antes posible. Recuerde que somos un equipo pequeño y es posible que necesitemos algo de tiempo antes de responderle: Prayhands: lea aquí cómo elegir una tarea y nuestro flujo de trabajo de contribución

¿Tienes un problema o encontró un error?

Si encuentra algún problema en la instalación, abra un problema.

¿Tienes una pregunta? Pregúntele a nuestra comunidad, sería más fácil obtener una respuesta aquí que en los problemas.

Licencia

Con licencia bajo MIT

Copyright 2016-2021 Elliot for Water Organization Ltd.

Consulte nuestra guía de marcas registradas.