Giter Site home page Giter Site logo

bogymen / get.fleek.network Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fleek-network/get.fleek.network

0.0 0.0 0.0 1.02 MB

"Get Fleek Network" is an attempt to make our software more accessible. By providing scripts to automate the installation process of our software, we believe that it can help improve the onboarding experience of our users.

Shell 100.00%

get.fleek.network's Introduction

Get Fleek Network

Conventional Commits

"Get Fleek Network" is an attempt to make our software more accessible. By providing scripts to automate the installation process of our software, we believe that it can help improve the onboarding experience of our users.

⚠️ Disclaimer

The practice of "piped installers" has become widespread in recent years, as development teams try to help the users by providing an easy installation process, but that has security risks.

💡 A "pipe installer" is a term used to describe curl get.example.com/script.sh | bash, which is a curl request that pipes a file that it gets from a remote location into the bash interpreter which is used to allow you to interact with your operating system. You can find these "pipe installers" in Rust, Docker, etc; although they all are written differently and for different purposes and intent.

We try to reduce this risk by reducing the number of operations by informing and requesting permission from the user, which has to provide consent.

As a user, you are strongly advised to follow our Introductory Guides instead. Otherwise, run the "pipe installer" at your own risk!

All things considered, we advise you to read the source code which is publicly available in the repository to understand the process and make a decision of your own, about whether you find it safe to run the assisted installer or not.

👍 Alternatively, you may find the installation script that is provided as a good reference to follow on your own.

If you have any questions or feedback, find us on Discord.

🤖 Requirements

  • Bash >= 4.2

👋 Running the assisted installer

Open a new terminal window, and connect to a supported Linux server.

curl https://get.fleek.network | bash

Learn more about the assisted installer here

✏️ Documentation

Our documentation is available at https://docs.fleek.network/ where you can find guides, and references to help you! We do our best to provide you with the best onboarding experience, but as we keep developing there are a lot of changes and some troubleshooting might be required, and thus important to use our documentation and guides.

🧱 Architecture flow

  • The domain name get.fleek.network should have a CNAME record to the Github pages fleek-network.github.io.`
  • A Github action prepares and deploys to Github pages, the latest of the assisted install
  • The cURL request to get.fleek.network responds with the assisted install script
  • Uses bash on runtime

🙏 Contribution guideline

Create branches from the main branch and name it in accordance with conventional commits** here, or follow the examples below:

test: 💍 Adding missing tests
feat: 🎸 A new feature
fix: 🐛 A bug fix
chore: 🤖 Build process or auxiliary tool changes
docs: ✏️ Documentation only changes
refactor: 💡 A code change that neither fixes a bug or adds a feature
style: 💄 Markup, white-space, formatting, missing semi-colons...

Find more about contributing here, please!

get.fleek.network's People

Contributors

heldrida avatar ozwaldorf avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.