elliotforwater.com

艾略特（Elliot）供水 - 前端

Elliot for Water是搜索引擎，可以通过您的搜索捐赠水：https：//elliotforwater.com

艾略特（Elliot）的水是一家社会企业，其使命是为数百万的人提供安全饮用水。实际上，艾略特（Elliot）的水与其他任何搜索引擎一样，但是额外的特征是我们捐赠了60％的利润来实现干净的水项目。

我们是一支非常小的团队，不断地研究Elliotforwater，使其成为可以帮助数百万人的现实。为此，我们需要开发更多的功能，使项目可以更快地移动并提供我们的用户喜欢使用的产品。如果您正在考虑做出贡献，那么您可以从这个项目中获得很多收益：您可以从事一个实际上可以帮助有需要的人并在世界上改变世界的项目。您将使用现代技术，并有空间可以从事中等大小的任务，这实际上会产生不同的作用，并在生产中就有您的标志。您将与一支开放的年轻团队合作，兴奋地交换想法并获得新的意见。

系统版本

节点14

NPM 6.14.11

NextJS 10

建立状态

分支	地位
主要的
发展

文档

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

如何开始

该项目是由Reactjs ， Nextjs ， Typescript ， Storybook和Jest构建的。要运行该项目，您需要在计算机上安装：

• Nodejs > 8
• npm

克隆后，仓库继续并安装所有软件包：

• npm i必须从root运行
• npm run dev开发开发环境中运行
• npm run build以运行构建项目并检查错误
• npm run storybook运行故事书并查看UI组件
• npm run test以运行测试覆盖

请查看package.json ，以发现您可以运行的更多脚本。

API和后端连接

该项目是Elliotforwater的前端代码。为了填充搜索结果，我们必须使用在不是开源的不同存储库中保存的内部API。 （我们也正在考虑开源，但我们需要研究它的法律含义。）我们的API在分期和生产环境中运行。为了开发目的，您也可以使用登台环境。您会在.env.staging文件中找到解释性评论。

我想帮忙！我该如何开始？

我们总是欢迎任何种类的贡献者。您可以支持我们编写代码，测试，写作翻译，提供有关UI，UX，SEO或发现错误或请求新功能的提示。在我们的GitHub问题中，您会找到主要需要帮助的不同任务。然后，您会欢迎您抓住任何这些任务并处理它。请分配您想做的任务，向团队沟通任何疑问，疑虑，不清楚的规范或改进想法。

我们总是欢迎新的反馈！如果您对如何改进项目有任何想法，请随时打开一个问题，标记有ideas ，我们将尽快检查和回答您。请记住，我们是一支小型团队，我们可能需要一些时间才能与您联系：祈祷者：请阅读此处如何选择任务和我们的贡献工作流程

有问题还是发现了错误？

如果您在安装中遇到任何问题，请打开问题。

有问题吗？询问我们的社区，在问题中，在这里获得答案会更容易。

执照

根据麻省理工学院许可

版权所有2016-2021艾略特水组织有限公司。

检查我们的商标指南。