Getting started

What is Fleek?

Fleek is an onchain edge-optimized cloud platform that allows users to build, host, and deploy websites and applications efficiently, empowering developers to create fast and high-performing apps.

Fleek is powered by the onchain edge-optimized cloud network known as Fleek Network and it gives access to a variety of features and capabilities that makes it easy to manage cloud infrastructure.

How to get started

Below are a few resources to help you get started with Fleek. Whether you’re new to the platform or looking to dive deeper into our features, these sections below will help you navigate Fleek.

Host an app

Learn how to host a React app and a Fleek template app in Astro on Fleek using the Fleek platform app. You will need to have an account on the Fleek app to follow the steps below.

Using the Fleek app

The platform provides seamless integration with Git, allowing you to deploy directly from your repositories. Fleek’s hosting service simplifies the deployment process with just a few clicks.

For step-by-step instructions on selecting repositories, and deploying your project, you can refer to Fleek platform’s Hosting documentation. This guide will walk you through the entire process of deploying your live site from the Fleek app.

Using the Fleek CLI

Fleek CLI provides a streamlined way to deploy your projects, giving you full control from the command line. With simple commands, you can create, configure, and deploy sites directly to the Fleek platform.

To get started with the Fleek CLI, you’ll first need to install it and log in to your account. For detailed instructions on deploying sites, including cloning repositories and initializing projects, refer to Fleek’s CLI Documentation.

A quick overview of deploying a site via Fleek CLI is as simple as:

Create a project
Set up pages
Initialize a Fleek site
Deploy the site

Fleek Functions quick start

Fleek Functions are edge-optimized functions on the Fleek Network, you can use them to perform server-side operations.

Ensure you have the Fleek CLI by running the command:

npm install -g @fleek-platform/cli

For this quick start, we will deploy a simple function that returns an “hello world” string response. You can use the Fleek app or Fleek CLI for this.

Using the Fleek app

On the project’s dashboard, click on the “Functions” button on the secondary navigation
Click on the “Create function” button on the extreme right-hand of the secondary navigation and a modal pops up:
Go through the steps (from step 1 through to step 4) and follow the instructions per step
- Since you have the Fleek CLI installed, type the following command to log in to your Fleek account from the CLI:
```
fleek login
```
- We also need to switch to the Fleek project we created the Fleek Function within from the platform using the project ID. We use the command below to do that from the CLI:
```
fleek projects switch --id={{PROJECT_ID}}
```
- Create a file in a directory on your machine and name it function.js. In the file, write the below code:
```
export const main = (params) => {
  return 'hello world';
};
```
- Create the Fleek Function with the same name as the one you inputted on the Fleek platform using the below command:
```
    fleek functions create  --name demo-function
```
- Deploy the Fleek Function, using the below command:
```
fleek functions deploy --name demo-function --path <code_path>
```

You have successfully deployed a Fleek Function using the above steps from the Fleek platform UI and now the first section of our Fleek Function “Overview” page should look like this now with the “Pending” status updated:

Using the Fleek CLI

Deploying one is as easy as 4 steps:

Login to your Fleek account
```
fleek login
```
Create a draft function: You can write a Typescript or JavaScript function

To start, create a new Fleek project by running:
```
touch my-first-function.js
```
In your text editor, add the following code:
```
export const main = (params) => {
  return 'hello world';
};
```
Create your Fleek Function

To start, create a new Fleek project by running:
```
fleek functions create --name my-first-function
```

Deploy your Fleek Function

To start, create a new Fleek project by running:

fleek functions deploy \
--name my-first-function \
--path ~/some/path/my-first-function.js

Fleek storage quickstart

Fleek’s storage service enables the decentralized storage of your files by leveraging the edge-optimized Fleek Network. The service supports IPFS as our main storage protocol, complemented by Arweave and Filecoin as a backup layer

Using the Fleek app

To use Fleek storage, you can follow the steps below:

Navigate to the “Storage” tab
Click the “Add New” button to upload a file or folder

Using the Fleek CLI

With the CLI already installed, you can also access the Fleek storage service.

To add a file “hello_world.txt” to Fleek Storage simply run the command:

fleek storage add ~/MyFiles/hello_world.txt

You can also perform other operations listing all the files or directories in the Fleek Storage for the current project and deleting a file or directory from the Fleek Storage. You can find more information on the Fleek CLI storage commands here.

Help and tutorials

Find links to useful resources to help get started, understand a concept or to get yourself onboarded to using Fleek for building edge-optimized applications.

Videos to help you with Fleek

Read our guides

In this section, you’ll find helpful guides designed to assist you with the most commonly-encountered tasks on Fleek. For a deeper understanding and more extensive information, our documentation is available to provide further insights and support.

To get up to speed with deploying your website or application, check out the below guides:

For all of our guides and more, visit our guides section:

View guides

Join our community and stay up-to-date with the latest news, features, and insights from our team. Follow us on social media to receive updates, engage with our community, and share your thoughts. Connect with us on Discord for real-time conversations, support, and collaboration. Together, we’re shaping the future of our service.

Join our Discord

Overview

Edit this page