Elliot For Water - Frontend

Elliot for Water is the search engine that donates water with your searches: https://elliotforwater.com

Elliot for Water is a social enterprise, with the mission of providing millions of people with access to safe drinking water. In practice, Elliot for Water is like any other search engine but with the extra characteristic that we donate 60% of our profit to realize clean water projects.

We are very small team, incessantly working on ElliotForWater to make it become a reality which can help million of people. To do so we need to develop more functionalities which allow the project to move faster and to delivery a product that our users will love use it. If you are considering contributing, there is a lot you could gain from this project: you could work on a project that actually help people in need and make the difference in the world. You will work with modern technologies and will have space to work on medium size task, which will actually make the difference and have your sign once in production. And you will work with an open-minded, young team excited to have ideas exchange and to get new inputs.

System versions

Node 14

npm 6.14.11

nextjs 10

Build Status

Branch	Status
main
develop

Documentation

Please find all the project related information in the Wiki

How to start

This project is built with Reactjs, Nextjs, Typescript, Storybook and Jest. To run the project you need to have install on your machine:

Nodejs > 8
npm

Once you clone the repo go ahead and install all the packages:

npm i must be run from root
npm run dev to run in development environment
npm run build to run build the project and check for errors
npm run storybook to run storybook and have a look at the UI components
npm run test to run test coverage

Please have a look at package.json to discover more scripts you can run.

API and Backend connection

This project is the Frontend code of ElliotForWater. To populate the search results, we have use internal API which are held in a different repository, which is not open source. (We are considering to open source that one too but we need to check better the legal implication of it.) Our API run in Staging and production environment. For the purpose of the development you can use the staging environment too. You will find explanatory comment in the .env.staging file.

I want to help out! How can I start?

Since we are very small team and we don't have so much time, we decided to set up some tasks were we need more help in the github project board. You are more then welcome to grab any of this task and work on it. Please assign the task you want to work on to your self, communicate to the team any doubts, concern, unclear specification or ideas of improvements. We always welcome new feedbacks! If you have any ideas on how to improve the project, please feel free to open an issue, label with ideas and we will check and answer you asap. Again, please remember we are very small team and we might need some times before getting back to you :prayhands: Please read here how to pick a tasks and our contribution workflow

Got a problem or found a bug?

If you encounter any problem in the installation, please open an issue.

Got a questions? Ask to our community, would be easier to get an answer here then in the issues.

License

Licensed under MIT

Check our Trademark guideline.

AllanOcelot / elliotforwater.com