Skip to content

Commit

Permalink
[Documentation] Add first version of FAQ file (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
@EmmanuelAR
EmmanuelAR authored Nov 25, 2024
1 parent e02b53b commit 2a4b5fb
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 33 deletions.
91 changes: 91 additions & 0 deletions FAQ.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# 🎉 Frequently Asked Questions (FAQ) 🎉

Welcome to the **CofiBlocks FAQ** section! Here you’ll find answers to the most common questions about our platform, including its purpose, setup, features, and how to contribute. If you’re new here, this is a great place to start! 🚀

## 📚 Sections
1. [General Questions](#general-questions)
2. [Community Questions](#community-questions)
3. [Technical Questions](#technical-questions)
4. [Contribution Questions](#contribution-questions)

## General Questions

### 1. How to get started? 🤔

To begin understanding the **CofiBlocks** project, we recommend following these steps:

1. **📄 Read the main README file:**
Get a comprehensive explanation of the project’s purpose and scope. You can find it [here](./README.md).

2. **👥 Review the Community Guidelines:**
Familiarize yourself with the community standards by reading the [Community Guidelines](./COMMUNITY_GUIDELINES.md).

3. **🔍 Understand the project structure:**
The project is divided into two main parts:
- **Backend:** Learn more by reading the [backend README](./apps/snfoundry/README.md).
- **Frontend:** Discover details by checking the [frontend README](./apps/web/README.md).

## Community Questions

Discover how to be an active and respectful member of the **CofiBlocks** community! Learn about our values, expectations, and how to contribute positively to our mission. 🌍

[📖 Read the full Community Guidelines here.](./COMMUNITY_GUIDELINES.md)

### 1. 🤝 What is a Collaborative Business?
A Collaborative Business is an organization where customers, producers, and supporters become members. These members share responsibility, decision-making, and benefits (both monetary and otherwise). Our model represents an evolution of the cooperative and DAO (Decentralized Autonomous Organization) concepts, leveraging blockchain technology, smart contracts, and crypto assets (such as NFTs and social currencies).

### 2. ☕ How CofiBlocks Business Works?

#### 🏡 Cofi in Your Home
Subscribers receive freshly roasted coffee delivered to their doorsteps monthly, ensuring they enjoy the finest brews while supporting local producers.

#### ⚖️ Cofi is Fair
Producers receive fair payments upfront, allowing them to plan and understand demand ahead of time, thanks to our subscription model.

#### 🎨 Cofi Art & NFTs
In its pilot year, CofiBlocks will create a collection of NFTs featuring original artwork, distributed via coffee labels on each bag sold.

#### 🪙 Cofi Complementary Currency
Members of the CofiBlocks pilot community on the Cambiatus app can claim their COFI tokens—a complementary blockchain currency that ensures participation in the Collaborative Business's benefits.

#### 📈 Cofi Distribution
At the end of the first year, all CofiBlocks members will receive a percentage of the pilot's financial results in cryptocurrency based on their accumulated COFI tokens. Members will also have the opportunity to participate in decision-making for future stages of the project.

#### 🔗 CofiBlocks & Cambiatus

CofiBlocks is a proud member of Cambiatus's Social Currency and Collaborative Business Ecosystem.

[🌐 Learn More About Cambiatus](https://cambiatus.com)

#### 🚀 CofiBlocks & Starknet

We're building our Web3 marketplace using Starknet technology.

[💻 Explore on GitHub](https://github.com/Vagabonds-Labs/marketplace)

### 3. 🗣️ How Can I Join the Community Conversations?
Connect with us on our community group chats to discuss ideas, share feedback, and engage with other members!

[💬 Join the Community Here](https://github.com/Vagabonds-Labs/cofiblocks?tab=readme-ov-file#-join-the-community)

## Technical Questions

### 1. How can I run the backend locally? 🖥️

You can run the **CofiBlocks** backend locally by following the steps in the [backend README](./apps/snfoundry/README.md).

### 2. How can I run the frontend locally? 🌐

To run the **CofiBlocks** frontend locally, follow the steps in the [frontend README](./apps/web/README.md).

### 3. Where can I find development resources? 📚

Explore all the resources, tools, and guides for developers working on **CofiBlocks** in our [Development Resources](https://github.com/Vagabonds-Labs/cofiblocks?tab=readme-ov-file#-development-resources) section.

## Contribution Questions

Find everything you need to know about contributing to **CofiBlocks**, from submitting pull requests to following our coding standards. 📈

[Check the Contribution Guide here.](./pull_request_template.md)

We’re excited to have you on board! Let’s build something amazing together. 💪💥
33 changes: 0 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,6 @@

CofiBlocks is the first Collaborative Business connecting traditional coffee-growing communities in Costa Rica and worldwide directly with coffee lovers using Starknet blockchain technology. Our mission is to distribute benefits among all members, ensuring fair trade, community engagement, and technological innovation.

## 🌍 What is a Collaborative Business?

A Collaborative Business is an organization where customers, producers, and supporters become members. These members share responsibility, decision-making, and benefits (both monetary and otherwise). Our model represents an evolution of the cooperative and DAO (Decentralized Autonomous Organization) concepts, leveraging blockchain technology, smart contracts, and crypto assets (such as NFTs and social currencies).

## 🌟 How Does It Work?

### Cofi in Your Home
Subscribers receive freshly roasted coffee delivered to their doorsteps monthly, ensuring they enjoy the finest brews while supporting local producers.

### Cofi is Fair
Producers receive fair payments upfront, allowing them to plan and understand demand ahead of time, thanks to our subscription model.

### Cofi Art & NFTs
In its pilot year, CofiBlocks will create a collection of NFTs featuring original artwork, distributed via coffee labels on each bag sold.

### Cofi Complementary Currency
Members of the CofiBlocks pilot community on the Cambiatus app can claim their COFI tokens—a complementary blockchain currency that ensures participation in the Collaborative Business's benefits.

### Cofi Distribution
At the end of the first year, all CofiBlocks members will receive a percentage of the pilot's financial results in cryptocurrency based on their accumulated COFI tokens. Members will also have the opportunity to participate in decision-making for future stages of the project.

## 🔗 CofiBlocks & Cambiatus

CofiBlocks is a proud member of Cambiatus's Social Currency and Collaborative Business Ecosystem.

[Learn More About Cambiatus](https://cambiatus.com)

## 🚀 CofiBlocks & Starknet

We're building our Web3 marketplace using Starknet technology.

[Explore on GitHub](https://github.com/Vagabonds-Labs/marketplace)

## 🛠️ Getting Started

### Prerequisites
Expand Down

0 comments on commit 2a4b5fb

Please sign in to comment.