elliotforwater.com

Elliot pour l'eau - frontend

Elliot pour l'eau est le moteur de recherche qui donne de l'eau avec vos recherches: https://elliotforwater.com

Elliot pour l'eau est une entreprise sociale, avec la mission de fournir aux millions de personnes un accès à l'eau potable. Dans la pratique, Elliot pour l'eau est comme tout autre moteur de recherche, mais avec la caractéristique supplémentaire que nous donnons 60% de nos bénéfices pour réaliser des projets en eau potable.

Nous sommes une très petite équipe, travaillant sans cesse sur Elliotforwater pour le faire devenir une réalité qui peut aider des millions de personnes. Pour ce faire, nous devons développer plus de fonctionnalités qui permettent au projet de se déplacer plus rapidement et de livrer un produit que nos utilisateurs adoreront utiliser. Si vous envisagez de contribuer, vous pouvez gagner beaucoup de choses à partir de ce projet: vous pouvez travailler sur un projet qui aide réellement les gens dans le besoin et fait une différence dans le monde. Vous travaillerez avec les technologies modernes et aurez de l'espace pour travailler sur des tâches de taille moyenne, ce qui fera en fait la différence et aura votre signe une fois en production. Et vous travaillerez avec une jeune équipe ouverte d'esprit excitée d'échanger des idées et d'obtenir de nouvelles contributions.

Versions système

Node 14

NPM 6.14.11

Nextjs 10

Statut de construction

Bifurquer	Statut
principal
développer

Documentation

Veuillez trouver toutes les informations liées au projet dans les liens rapides du Wiki: configuration du projet et utilisation: https://github.com/elliotforwater/elliotforwater.com/wiki/1.set-ulp-and-usage comment contribuer: https://gihub.com/elliotforwater/elliotforwater.com/wiki/3.-How-to-To-To-Contraut https://github.com/elliotforwater/elliotforwater.com/wiki/7.code-tyleguide

Comment commencer

Ce projet est construit avec Reactjs , Nextjs , Typescript , Storybook et Jest . Pour exécuter le projet, vous devez installer sur votre machine:

• Nodejs > 8
• npm

Une fois que vous avez cloné le repo, allez-y et installez tous les packages:

• npm i dois être coulé de root
• npm run dev pour s'exécuter dans un environnement de développement
• npm run build pour exécuter la construction du projet et vérifier les erreurs
• npm run storybook pour exécuter le livre de contes et jeter un œil aux composants de l'interface utilisateur
• npm run test pour exécuter la couverture du test

Veuillez consulter package.json pour découvrir plus de scripts que vous pouvez exécuter.

API et connexion backend

Ce projet est le code frontal d'ElliotForwater. Pour remplir les résultats de la recherche, nous devons utiliser une API interne qui est maintenue dans un référentiel différent, qui n'est pas open source. (Nous envisageons d'ouvrir celle-ci aussi, mais nous devons rechercher les implications juridiques.) Notre API fonctionne dans un environnement de mise en scène et de production. Aux fins de développement, vous pouvez également utiliser l'environnement de mise en scène. Vous trouverez des commentaires explicatifs dans le fichier .env.staging .

Je veux aider! Comment puis-je commencer?

Nous accueillons toujours le contributeur de toute sorte. Vous pouvez nous aider à écrire du code, à tester, à écrire une traduction, à donner des conseils sur l'interface utilisateur, UX, SEO ou repérer des bogues ou demander de nouvelles fonctionnalités. Dans nos problèmes GitHub, vous trouverez différentes tâches qui ont principalement besoin d'aide. Vous êtes plus que le bienvenu pour saisir l'une de ces tâches et y travailler. Veuillez affecter la tâche sur laquelle vous souhaitez vous travailler, communiquez à l'équipe tout doute, préoccupation, spécification peu claire ou idées d'améliorations.

Nous accueillons toujours de nouveaux commentaires! Si vous avez des idées sur la façon d'améliorer le projet, n'hésitez pas à ouvrir un problème, à étiqueter avec ideas et nous vérifierons et vous répondrons dès que possible. N'oubliez pas que nous sommes une petite équipe et que nous pourrions avoir besoin de temps avant de vous répondre: Prayhands: Veuillez lire ici comment choisir une tâche et notre flux de travail de contribution

Vous avez un problème ou trouvé un bug?

Si vous rencontrez un problème dans l'installation, veuillez ouvrir un problème.

Vous avez une question? Demandez à notre communauté, ce serait plus facile d'obtenir une réponse ici dans les problèmes.

Licence

Sous licence sous MIT

Copyright 2016-2021 Elliot pour Water Organisation Ltd.

Vérifiez nos directives de marque.