The front page of the decentralized web
## Table of contents * [Introduction](https://github.com/Esteroids/esteroids-app/blob/master/#introduction) * [Web App](https://github.com/Esteroids/esteroids-app/blob/master/#web-app) * [Installation](https://github.com/Esteroids/esteroids-app/blob/master/#installation) * [Versioning](https://github.com/Esteroids/esteroids-app/blob/master/#versioning) * [Getting help](https://github.com/Esteroids/esteroids-app/blob/master/#getting-help) * [Getting involved](https://github.com/Esteroids/esteroids-app/blob/master/#getting-involved) * [License](https://github.com/Esteroids/esteroids-app/blob/master/#license) * [Credits and references](https://github.com/Esteroids/esteroids-app/blob/master/#credits-and-references) ## Introduction [Esteroids](https://github.com/Esteroids/esteroids-app/blob/master/https://esteroids.eth.limo) is a search engine for the decentralized web. It also includes tools for browsing which dWebsite the decentralized web has to offer. Esteroids is a decentralized website itself, based on ENS and IPNS (New to decentralized web, read this first: [Intro to dWebsites](https://github.com/Esteroids/esteroids-app/blob/master/http://blog.almonit.eth.link/2020-05-21/Introduction_to_Dwebsitse.html)). ## Web App This repository contains the source code of the web app that is the basis of [esteroids.eth](https://github.com/Esteroids/esteroids-app/blob/master/https://esteroids.eth.limo). Esteroids Web App is a React App. It has client side only, does not rely on any backend, and is meant for users to search the decentralized web in complete privacy. See live version in [esteroids.eth.limo](https://github.com/Esteroids/esteroids-app/blob/master/https://esteroids.eth.limo) ![Site screenshot](https://github.com/Esteroids/esteroids-app/blob/master/./docs/images/esteroids-screenshot.jpg) ## Installation To install all the dependencies run: ```yarn``` Then you can run the webapp locally with: ```yarn start``` or build a static version of it with: ```yarn build``` ## Versioning Esteroids App versioning consists of three letters, in the form `Vx.y.z`, where - a change of `x` is done in case of a new milestone, - a change of `y` is done in case of a new major feature, - a change of `z` is done in case of new small features, patches, or bug fixes. The first version is `V0.1.0` marking the beta version of Esteroids App. The reason we begin from Beta is due to the fact that Esteroids App Alpha had a different code base. ## Getting help If you have questions, concerns, bug reports, etc, please open an issue in this repository's Issue Tracker, send us an email to contact@esteroids.xyz or come to our [Discord](https://github.com/Esteroids/esteroids-app/blob/master/https://discord.gg/9c2EWzjFzY). ## Getting involved Esteroids is a project from the community by the community, and as such we encourage you to be involved. You can either contact us in email (contact@esteroids.xyz), [Twitter](https://github.com/Esteroids/esteroids-app/blob/master/https://twitter.com/e_steroids) or [Discord](https://github.com/Esteroids/esteroids-app/blob/master/https://discord.gg/9c2EWzjFzY), or simply form the project, add features, and do a PR for us to look at it. ---- ## License The code in this repository is published under MIT license. The content in this repository is published under CC-BY-SA 3.0 license. ---- ## Credits and references Esteroids was created by [Tomer Leicht](https://github.com/Esteroids/esteroids-app/blob/master/https://github.com/tomlightning) and [Eyal Ron](https://github.com/Esteroids/esteroids-app/blob/master/https://github.com/eyalron33).