From f7f25c3d155001af686fe2a852339eb79937b58f Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Mon, 25 Nov 2024 19:04:45 -0600 Subject: [PATCH 1/7] [docs]: update documentation README.md --- README.md | 317 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 268 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index da6cce2..3282824 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,146 @@ -# CofiBlocks - La Comunidad del Café ☕️ +# **CofiBlocks - La Comunidad del Café ☕️** 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. -## 🛠️ Getting Started +CofiBlocks se presenta como el primer Negocio Colaborativo que conecta a las comunidades tradicionales productoras de café en Costa Rica, y en todo el mundo, directamente con los amantes del café utilizando la tecnología blockchain Starknet. Nuestra misión es distribuir beneficios entre todos los miembros, asegurando el comercio justo, la participación de la comunidad y la innovación tecnológica. +## 🌍 **What is a Collaborative Business?** -### Prerequisites +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). + +## 📌 **Crucial concepts** + +1. **Collaborative Business** + +A model where multiple parties (individuals or companies) collaborate to create, operate, and benefit from a project or product. It relies on decentralization, shared decision-making, and fair profit distribution. + +2. **NFTs (Non-Fungible Tokens)** + +Unique digital assets based on blockchain, used to represent ownership of digital or physical items like art, music, or contracts. They are immutable, verifiable, and not directly interchangeable like cryptocurrencies. + + +3. **COFI Tokens** + +Digital assets serving as the unit of value and participation within the CofiBlocks ecosystem. Likely used for transactions, incentives, and governance in the project. + +## 🌟 **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. +``` + + + +## 🚀 Roadmap + +### **2022-2023 Season** +Thank you to everyone who participated in our first season and enjoyed coffee from the slopes of Volcán Poás. + +### **2024-2025 Season** +We are preparing to launch our second season, featuring coffee from additional coffee-growing regions of Costa Rica. + +**Want to bring CofiBlocks to your region?** + + + +- [Contact Us ](mailto:info@cofiblocks.com) + +## 👥 Meet the Team + +### ☕ **FOUNDERS** + +### Omar Hurtado Munguia +**Co-founder** + +Omar's journey from coffee picker to coffee tour guide in Poás de Alajuela inspired the creation of CofiBlocks. He brings firsthand knowledge of the challenges small producers face. + +### Karla Córdoba Brenes +**Co-founder** + +Karla contributes her extensive experience in blockchain technology and impact-driven solutions. + +### Ranulfo Paiva Sobrinho +**Co-founder** + +Ranulfo's background in blockchain development and collaborative economies helps drive the technical and organizational aspects of CofiBlocks. + +# + +### 💻 **DEVS** + +### Alberto - Brolag +**Full Stack Developer Web3** + +- [Brolag GitHub](https://github.com/brolag) +- [Twitter](https://x.com/brolag) + +### Erick - Evgongora +**Full Stack Developer Web3** + +- [Erick GitHub](https://github.com/evgongora) +- [Twitter](https://x.com/3rickDev) + +### Randall Valenciano +**Full Stack Developer Web3** + +- [Randall GitHub](https://github.com/rvalenciano) +- [Twitter](https://x.com/Ravf226) + + + +## 🔗 **CofiBlocks & Cambiatus** + +CofiBlocks is a proud member of Cambiatus's Social Currency and Collaborative Business Ecosystem. + +**Learn More About Cambiatus** + +- [Cambiatus](https://cambiatus.com) + +## 🚀 **CofiBlocks & Starknet** + +We're building our Web3 marketplace using Starknet technology. + +**Explore on GitHub** + +- [GitHub](https://github.com/Vagabonds-Labs/marketplace) + +## 🎉 Join the Community + +- Website: [CofiBlocks Website](https://cofiblocks.com) +- Twitter: [Follow us on Twitter](https://twitter.com/cofiblocks) +- Telegram ODHack: [Join our Telegram ODHACK Group](https://t.me/cofiblocksodhack) +- Telegram for Devs: [Join our Telegram Devs Cofi Group](https://t.me/cofiblocksodhack) + +## 🛠️ **Getting Started** + +### **Prerequisites** - Node.js (>= 18) - Bun package manager (bun@1.1.24) - Prisma -### Installation +### **Installation** + 1. Clone the repository: ```bash @@ -21,18 +152,25 @@ CofiBlocks is the first Collaborative Business connecting traditional coffee-gro ```bash bun install ``` +3. Rename + ```bash + mv .env.example to .env + ``` -3. Generate the Prisma client: +4. Generate the Prisma client: ```bash bun prisma generate ``` -4. Run the development server: +5. Run the development server: ```bash bun turbo dev ``` -### Project Structure +**Make sure the values in the .env file are configured correctly for your environment.** + + +### **Project Structure** The project is organized using workspaces: @@ -46,70 +184,142 @@ Key scripts include: - `db:migrate`: Apply database migrations. - `db:seed`: Seed the database with initial data. -## Contributing - -We welcome contributions from the community! Here's how you can help: +### **Key Technologies** -1. Fork the repository and create your branch: +1. **StarkNet** ```bash - git checkout -b feature/amazing-feature + StarkNet is a decentralized, permissionless Layer 2 solution for Ethereum. It uses ZK-STARKs (zero-knowledge proofs) to enable fast and cost-efficient transactions while ensuring security and scalability. Developers can deploy smart contracts, and users benefit from significantly reduced gas fees compared to Ethereum's mainnet. ``` - -2. Commit your changes: +2. **Prisma** ```bash - git commit -m "Add amazing feature" + Prisma is a modern database toolkit for Node.js and TypeScript. It provides an ORM (Object-Relational Mapping) that simplifies working with databases, allowing developers to define models and query data in a type-safe way. Prisma supports multiple databases, including PostgreSQL, MySQL, and MongoDB ``` - -3. Push to the branch: +3. **Bun** ```bash - git push origin feature/amazing-feature + Bun is an all-in-one JavaScript runtime that competes with Node.js and Deno. It’s built for performance and includes a fast bundler, transpiler, and package manager. Bun aims to speed up development workflows, reduce dependency on third-party tools, and execute JavaScript and TypeScript quickly. It’s designed to handle server-side apps, scripts, and front-end tooling. ``` -4. Open a Pull Request. +## 📝 **Contributing** -## Code of Conduct +We welcome contributions from the community! Here's how you can help: -We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved. +1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account. -## 🎉 Join the Community + - HERE -- Website: [CofiBlocks Website](https://cofiblocks.com) -- Twitter: [Follow us on Twitter](https://twitter.com/cofiblocks) +# -## 🚀 Roadmap +2. **Clone the Fork:** + - Clone the forked repository to your local machine by running the following command: -### 2022-2023 Season -Thank you to everyone who participated in our first season and enjoyed coffee from the slopes of Volcán Poás. + ```bash + git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git + ``` -### 2024-2025 Season -We are preparing to launch our second season, featuring coffee from additional coffee-growing regions of Costa Rica. + - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name. -Want to bring CofiBlocks to your region? [Contact Us](mailto:info@cofiblocks.com) +# -## 👥 Meet the Team +3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. -### Omar Hurtado Munguia -**Co-founder** + - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`). -Omar's journey from coffee picker to coffee tour guide in Poás de Alajuela inspired the creation of CofiBlocks. He brings firsthand knowledge of the challenges small producers face. + ``` + git checkout -b branch-name + ``` + - One of ideas on how to implement it for the branch name: -### Karla Córdoba Brenes -**Co-founder** + > `docs/update-readme` or `fix/bottom-bug`. -Karla contributes her extensive experience in blockchain technology and impact-driven solutions. +# -### Ranulfo Paiva Sobrinho -**Co-founder** +4. **Commit:** Commit your changes. -Ranulfo's background in blockchain development and collaborative economies helps drive the technical and organizational aspects of CofiBlocks. + 1. **git add (file-name)** + 2. **git commit -m "[type] description"** + + - Example: + ``` + `git add Create_Documentation` + + `git commit -m "[docs]: update documentation"` + ``` + +# + +5. **Push fork:** Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. + +- Push your changes to your forked repository: + ```bash + git push origin your-branch-name + ``` + > Replace `your-branch-name` with the name of your branch. + +- Example: + + ```bash + `git push origin fix/bug-fix` + ``` + +# + +6. **Submit a Pull Request:** Submit a pull request to the `dev` branch of the Semaphore Stellar SDK repository. + + - Summit pull request + +# **📁 Commits** + +You can do a regular commit by following the next: + +``` [type] significant message ``` + +- Learn more about conventional commits + +### Type + +**The type must be one of the following:** + +- feat: A new feature. +- fix: A bug fix. +- docs: Documentation only changes. +- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). +- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure). +- perf: A code change that improves the performance. +- test: Adding missing or correcting existing tests. +- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm). +- ci: Changes to CI configuration files and scripts (example scopes: travis, circle). +- chore: Other changes that don't modify src or test files. +- revert: Reverts a previous commit. + +# **🔗 Branches** +1. There must be a `main` branch, used only for the releases. +2. Avoid long descriptive names for long-lived branches. +3. Use kebab-case (no CamelCase). +4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit). +5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow. +6. Use slashes to separate parts of your branch names. +7. Remove your branch after merging it if it is not important. +**Examples:** +``` +git branch -b docs/readme +git branch -b test/a-feature +git branch -b feat/sidebar +git branch -b fix/b-feature +``` + +## 📚 **Code of Conduct** + +We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved. ## 🤖 Development Resources -### CofiBlocks Dev Assistant +### **CofiBlocks Dev Assistant** We've created a custom GPT to assist with development tasks related to CofiBlocks. This AI-powered assistant is designed to help with coding, answer questions about our tech stack, and provide guidance on best practices. -Access the CofiBlocks Dev Assistant here: [CofiBlocks Dev Assistant](https://chatgpt.com/g/g-JIRAV36d5-cofiblocks-dev-assistant) +Access the CofiBlocks Dev Assistant here: + +- [CofiBlocks Dev Assistant](https://chatgpt.com/g/g-JIRAV36d5-cofiblocks-dev-assistant) Features: - Coding assistance for our tech stack (Next.js, TypeScript, TailwindCSS, etc.) @@ -120,18 +330,27 @@ Features: Feel free to use this resource during your development process to streamline your workflow and get quick answers to your questions. -### Prompt Guide +### **Prompt Guide** To streamline our development process and maintain consistency across the project, we've created a comprehensive prompt guide. This guide covers various custom prompts designed to assist with component generation, code-related tasks, and information retrieval. -Key features of our prompt guide include: +**Key features of our prompt guide include:** -- Instructions for using SudoLang, a powerful pseudocode language for AI collaboration +- Instructions for using SudoLang, a powerful pseudocode language for AI collaboration. - Detailed usage guidelines for our custom prompts: - - V0PromptWithComponent for generating v0.dev prompts - - TailwindReactComponentGenerator for creating React components with Tailwind CSS - - PerplexityBot for efficient information searches + ``` + V0PromptWithComponent for generating v0.dev prompts + ``` + ``` + TailwindReactComponentGenerator for creating React components with Tailwind CSS + ``` + ``` + PerplexityBot for efficient information searches + ``` - Best practices for prompt usage and troubleshooting tips -For full details and usage instructions, please refer to our [Prompt Guide](docs/prompt-guide.md). +**For full details and usage instructions, please refer to our** + +- [Prompt Guide](docs/prompt-guide.md). +# \ No newline at end of file From 93c5863800432fea0c7930e8e8cb7a33638b5654 Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Mon, 25 Nov 2024 19:09:38 -0600 Subject: [PATCH 2/7] [docs]: update documentation README.md and Information --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3282824..aa1ce56 100644 --- a/README.md +++ b/README.md @@ -247,7 +247,7 @@ We welcome contributions from the community! Here's how you can help: # -5. **Push fork:** Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. +5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. - Push your changes to your forked repository: ```bash @@ -263,7 +263,7 @@ We welcome contributions from the community! Here's how you can help: # -6. **Submit a Pull Request:** Submit a pull request to the `dev` branch of the Semaphore Stellar SDK repository. +6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. - Summit pull request From a2c2276808eb06e8379aace9e0db0eb78d867155 Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Wed, 27 Nov 2024 23:37:59 -0600 Subject: [PATCH 3/7] [docs]: update documentation add information for README.md --- README.md | 88 +++++++++++-------------------------------------------- 1 file changed, 17 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index aa1ce56..0102ced 100644 --- a/README.md +++ b/README.md @@ -2,56 +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. -CofiBlocks se presenta como el primer Negocio Colaborativo que conecta a las comunidades tradicionales productoras de café en Costa Rica, y en todo el mundo, directamente con los amantes del café utilizando la tecnología blockchain Starknet. Nuestra misión es distribuir beneficios entre todos los miembros, asegurando el comercio justo, la participación de la comunidad y la innovación tecnológica. -## 🌍 **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). - -## 📌 **Crucial concepts** - -1. **Collaborative Business** - -A model where multiple parties (individuals or companies) collaborate to create, operate, and benefit from a project or product. It relies on decentralization, shared decision-making, and fair profit distribution. - -2. **NFTs (Non-Fungible Tokens)** - -Unique digital assets based on blockchain, used to represent ownership of digital or physical items like art, music, or contracts. They are immutable, verifiable, and not directly interchangeable like cryptocurrencies. - - -3. **COFI Tokens** - -Digital assets serving as the unit of value and participation within the CofiBlocks ecosystem. Likely used for transactions, incentives, and governance in the project. - -## 🌟 **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. -``` - - - ## 🚀 Roadmap ### **2022-2023 Season** @@ -62,10 +12,22 @@ We are preparing to launch our second season, featuring coffee from additional c **Want to bring CofiBlocks to your region?** +- [Contact Us ](mailto:info@cofiblocks.com) + +## 🌎 Movement +``` +CofiBlocks is more than just a coffee marketplace; it's a movement for a more equitable and sustainable coffee future. With a strong foundation and a passionate community, CofiBlocks is poised to transform the way coffee is produced, distributed, and enjoyed worldwide. Whether you're a coffee enthusiast or a blockchain believer, CofiBlocks invites you to join their journey. +``` + +## 📌 Fundamental Links Info +- [Learning about modern collaborative businesses with CofiBlocks](https://medium.com/cambiatus/conociendo-de-modernos-negocios-colaborativos-con-cofiblocks-88ed3ddfa88a) + +- [CofiBlocks: Innovating the Coffee Industry in Costa Rica with Web3](https://mirror.xyz/0xF574753688ABf9740660DFb02E84E4599CA6Eb87/QneFnlPqTRuV_3jt7Kd6foBfFokOKN6zNcJCqpj_xkw) -- [Contact Us ](mailto:info@cofiblocks.com) + +- [Pitch Deck](https://docs.google.com/presentation/d/16zPeDC-6fMaCRRpaQCTPPIn_ZKdI0d9ZArkTxd2wmAA/edit#slide=id.p1) ## 👥 Meet the Team ### ☕ **FOUNDERS** @@ -75,6 +37,8 @@ We are preparing to launch our second season, featuring coffee from additional c Omar's journey from coffee picker to coffee tour guide in Poás de Alajuela inspired the creation of CofiBlocks. He brings firsthand knowledge of the challenges small producers face. +- [History](https://www.youtube.com/watch?v=OjymLl3zKss) + ### Karla Córdoba Brenes **Co-founder** @@ -87,7 +51,7 @@ Ranulfo's background in blockchain development and collaborative economies helps # -### 💻 **DEVS** +### 💻 **MAINTAINERS** ### Alberto - Brolag **Full Stack Developer Web3** @@ -107,28 +71,10 @@ Ranulfo's background in blockchain development and collaborative economies helps - [Randall GitHub](https://github.com/rvalenciano) - [Twitter](https://x.com/Ravf226) - - -## 🔗 **CofiBlocks & Cambiatus** - -CofiBlocks is a proud member of Cambiatus's Social Currency and Collaborative Business Ecosystem. - -**Learn More About Cambiatus** - -- [Cambiatus](https://cambiatus.com) - -## 🚀 **CofiBlocks & Starknet** - -We're building our Web3 marketplace using Starknet technology. - -**Explore on GitHub** - -- [GitHub](https://github.com/Vagabonds-Labs/marketplace) - ## 🎉 Join the Community - Website: [CofiBlocks Website](https://cofiblocks.com) -- Twitter: [Follow us on Twitter](https://twitter.com/cofiblocks) +- X: [Follow us on Twitter](https://twitter.com/cofiblocks) - Telegram ODHack: [Join our Telegram ODHACK Group](https://t.me/cofiblocksodhack) - Telegram for Devs: [Join our Telegram Devs Cofi Group](https://t.me/cofiblocksodhack) From 86a9c8a0d2b26cb78296091bc80bf96b4cc82fcf Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Sat, 30 Nov 2024 00:50:01 -0600 Subject: [PATCH 4/7] [docs]: Update README.md and CONTRIBUTING.md From ee877f7699ab89d9dab0d95afdc72c287b0bfb9e Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Sat, 30 Nov 2024 01:03:31 -0600 Subject: [PATCH 5/7] [docs]: Update README.md and CONTRIBUTING.md final --- CONTRIBUTING.md | 137 +++++++++++++++++++++++++--------------- README.md | 163 ++++++++++++++++-------------------------------- 2 files changed, 140 insertions(+), 160 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed0a423..57640a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,81 +1,116 @@ -# ☕ Contributing to CofiBlocks +# **CONTRIBUTING GUIDE BY COFIBLOCKS** ☕ -Thank you for your interest in contributing to **CofiBlocks**! This document outlines the steps to get started, guidelines for contributions, and how to collaborate effectively with the team. +Thank you for your interest in contributing to CofiBlocks! We appreciate your time and effort in making our project better. ---- +This guide will help you get started with contributing to our project. Please note that we have a code of conduct, which we expect all contributors to adhere to. -## 🚀 Contribution Guideline +## 📝 **Contributing** -### Getting Started -- 🔍 Visit the [Issues](https://github.com/Vagabonds-Labs/cofiblocks/issues) tab to see ongoing work or feature requests -- 💬 If you find an issue that interests you, comment to express your interest -- 📝 For new ideas, create a detailed issue with clear descriptions +We welcome contributions from the community! Here's how you can help: -### Creating New Issues -- 🐛 For bugs, include steps to reproduce -- ✨ For features, describe the enhancement clearly +1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account. -### Start Working - - Once an issue is assigned to you, proceed with the technical steps described below. + - HERE ---- +# -## 🛠 How To Contribute +2. **Clone the Fork:** + - Clone the forked repository to your local machine by running the following command: -1. Fork the repository to your GitHub account first. + ```bash + git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git + ``` -2. Clone the repository in your local machine: -```bash -git clone https://github.com/YOUR_USERNAME/cofiblocks.git -cd marketplace -``` + - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name. -2. Create and switch to your branch: -```bash -git checkout -b feature/amazing-feature -``` +# -3. Make changes: -Make your changes. Ensure your code adheres to the project's coding style and standards. +3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. -4. Add and commit your changes: -```bash -git add . -git commit -m "Add amazing feature" -``` + - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`). -5. Push to the branch: -```bash -git push origin feature/amazing-feature -``` + ``` + git checkout -b branch-name + ``` + - One of ideas on how to implement it for the branch name: + + > `docs/update-readme` or `fix/bottom-bug`. + +# + +4. **Commit:** Commit your changes. + + 1. **git add (file-name)** + 2. **git commit -m "[type] description"** -6. Open a Pull Request. -Once your changes are ready, submit a Pull Request for review. Ensure that: + - Example: + ``` + git add Create_Documentation -Ensure your PR has a clear title, a detailed description of the changes, and references any related issues (if applicable). + git commit -m "[docs]: update documentation" + ``` -All contributions go through the PR review process to maintain code quality. After review, maintainers will provide feedback or merge it into the main branch. +# ---- +5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. -## Code of Conduct +- Push your changes to your forked repository: + ```bash + git push origin your-branch-name + ``` + > Replace `your-branch-name` with the name of your branch. -We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved. +- Example: ---- + ```bash + git push origin fix/bug-fix + ``` -## 🌐 Community Resources +# -Stay connected with the **CofiBlocks** community! Here are the resources where you can engage, stay informed, and collaborate with the team and other contributors: +6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. -- **Twitter** - Follow us on [Twitter](https://x.com/cofiblocks) + - Summit pull request -- **Website** - Visit our [Official Website](https://www.cofiblocks.com/) +# **📁 Commits** -We look forward to your active participation and contributions! 🚀 +You can do a regular commit by following the next: +``` [type] significant message ``` +- Learn more about conventional commits +### Type +Add changes you worked on the issue. + +**Examples:** + +```bash +git commit -m "[docs]: update documentation" +``` + +```bash +git commit -m "[fix]: fix bug in code" +``` + +```bash +git commit -m "[test]: add test case" +``` + +# **🔗 Branches** +1. There must be a `main` branch, used only for the releases. +2. Avoid long descriptive names for long-lived branches. +3. Use kebab-case (no CamelCase). +4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit). +5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow. +6. Use slashes to separate parts of your branch names. +7. Remove your branch after merging it if it is not important. +**Examples:** +``` +git branch -b docs/readme +git branch -b test/a-feature +git branch -b feat/sidebar +git branch -b fix/b-feature +``` +# \ No newline at end of file diff --git a/README.md b/README.md index 0102ced..3ca1675 100644 --- a/README.md +++ b/README.md @@ -85,8 +85,45 @@ Ranulfo's background in blockchain development and collaborative economies helps - Bun package manager (bun@1.1.24) - Prisma -### **Installation** +### **Crate file** + +`/cofiblocks/apps/web/sql/init.sql` + +- And REPLACE MYSQL_USER with your mysql user in the .env +```bash +GRANT CREATE ON *.* TO ''@'%'; +GRANT ALL PRIVILEGES ON *.* TO ''@'%'; +``` +### **Docker-compose.yml** + +Add this to your docker-compose.yml file: + +```bash +version: '3.8' +services: + db: + image: mysql:8.4 + container_name: mysql + restart: always + env_file: + - ./apps/web/.env + ports: + - '3306:3306' + healthcheck: + test: ['CMD-SHELL', 'mysqladmin ping -h 127.0.0.1 --password="$$(cat /run/secrets/db-password)" --silent'] + interval: 3s + retries: 5 + start_period: 30s + volumes: + - mysql-data:/var/lib/mysql + - ./apps/web/sql/init.sql:/docker-entrypoint-initdb.d/init.sql + +volumes: + mysql-data: +``` + +### **Installation** 1. Clone the repository: ```bash @@ -94,6 +131,8 @@ Ranulfo's background in blockchain development and collaborative economies helps cd marketplace ``` + - Run `docker compose up`, to access the database. + 2. Install dependencies: ```bash bun install @@ -102,6 +141,20 @@ Ranulfo's background in blockchain development and collaborative economies helps ```bash mv .env.example to .env ``` + **And add this in your .env file:** + + ```bash + MYSQL_ROOT_PASSWORD= + MYSQL_DATABASE= + MYSQL_USER= + MYSQL_PASSWORD= + + DATABASE_URL="mysql://${MYSQL_USER}:${MYSQL_PASSWORD + }@localhost:3306/${MYSQL_DATABASE}? + connect_timeout=10" + ``` + **Important:** + - Add and run `docker compose up` in this part. 4. Generate the Prisma client: ```bash @@ -145,114 +198,6 @@ Key scripts include: Bun is an all-in-one JavaScript runtime that competes with Node.js and Deno. It’s built for performance and includes a fast bundler, transpiler, and package manager. Bun aims to speed up development workflows, reduce dependency on third-party tools, and execute JavaScript and TypeScript quickly. It’s designed to handle server-side apps, scripts, and front-end tooling. ``` -## 📝 **Contributing** - -We welcome contributions from the community! Here's how you can help: - -1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account. - - - HERE - -# - -2. **Clone the Fork:** - - Clone the forked repository to your local machine by running the following command: - - ```bash - git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git - ``` - - - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name. - -# - -3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. - - - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`). - - ``` - git checkout -b branch-name - ``` - - One of ideas on how to implement it for the branch name: - - > `docs/update-readme` or `fix/bottom-bug`. - -# - -4. **Commit:** Commit your changes. - - 1. **git add (file-name)** - 2. **git commit -m "[type] description"** - - - Example: - ``` - `git add Create_Documentation` - - `git commit -m "[docs]: update documentation"` - ``` - -# - -5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. - -- Push your changes to your forked repository: - ```bash - git push origin your-branch-name - ``` - > Replace `your-branch-name` with the name of your branch. - -- Example: - - ```bash - `git push origin fix/bug-fix` - ``` - -# - -6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. - - - Summit pull request - -# **📁 Commits** - -You can do a regular commit by following the next: - -``` [type] significant message ``` - -- Learn more about conventional commits - -### Type - -**The type must be one of the following:** - -- feat: A new feature. -- fix: A bug fix. -- docs: Documentation only changes. -- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). -- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure). -- perf: A code change that improves the performance. -- test: Adding missing or correcting existing tests. -- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm). -- ci: Changes to CI configuration files and scripts (example scopes: travis, circle). -- chore: Other changes that don't modify src or test files. -- revert: Reverts a previous commit. - -# **🔗 Branches** -1. There must be a `main` branch, used only for the releases. -2. Avoid long descriptive names for long-lived branches. -3. Use kebab-case (no CamelCase). -4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit). -5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow. -6. Use slashes to separate parts of your branch names. -7. Remove your branch after merging it if it is not important. -**Examples:** -``` -git branch -b docs/readme -git branch -b test/a-feature -git branch -b feat/sidebar -git branch -b fix/b-feature -``` - ## 📚 **Code of Conduct** We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved. From 672b53376cc509573b2034ec415612f3557853e6 Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Sat, 30 Nov 2024 20:19:12 -0600 Subject: [PATCH 6/7] git commit -m "[docs]: Update README.md final" --- CONTRIBUTING.md | 116 ------------------------------------------------ 1 file changed, 116 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 57640a7..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,116 +0,0 @@ -# **CONTRIBUTING GUIDE BY COFIBLOCKS** ☕ - -Thank you for your interest in contributing to CofiBlocks! We appreciate your time and effort in making our project better. - -This guide will help you get started with contributing to our project. Please note that we have a code of conduct, which we expect all contributors to adhere to. - -## 📝 **Contributing** - -We welcome contributions from the community! Here's how you can help: - -1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account. - - - HERE - -# - -2. **Clone the Fork:** - - Clone the forked repository to your local machine by running the following command: - - ```bash - git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git - ``` - - - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name. - -# - -3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. - - - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`). - - ``` - git checkout -b branch-name - ``` - - One of ideas on how to implement it for the branch name: - - > `docs/update-readme` or `fix/bottom-bug`. - -# - -4. **Commit:** Commit your changes. - - 1. **git add (file-name)** - 2. **git commit -m "[type] description"** - - - Example: - ``` - git add Create_Documentation - - git commit -m "[docs]: update documentation" - ``` - -# - -5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. - -- Push your changes to your forked repository: - ```bash - git push origin your-branch-name - ``` - > Replace `your-branch-name` with the name of your branch. - -- Example: - - ```bash - git push origin fix/bug-fix - ``` - -# - -6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. - - - Summit pull request - -# **📁 Commits** - -You can do a regular commit by following the next: - -``` [type] significant message ``` - -- Learn more about conventional commits - -### Type - -Add changes you worked on the issue. - -**Examples:** - -```bash -git commit -m "[docs]: update documentation" -``` - -```bash -git commit -m "[fix]: fix bug in code" -``` - -```bash -git commit -m "[test]: add test case" -``` - -# **🔗 Branches** -1. There must be a `main` branch, used only for the releases. -2. Avoid long descriptive names for long-lived branches. -3. Use kebab-case (no CamelCase). -4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit). -5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow. -6. Use slashes to separate parts of your branch names. -7. Remove your branch after merging it if it is not important. -**Examples:** -``` -git branch -b docs/readme -git branch -b test/a-feature -git branch -b feat/sidebar -git branch -b fix/b-feature -``` -# \ No newline at end of file From 86a0a1e5e7eef773c5f89b0af9f9b298c73b1ce1 Mon Sep 17 00:00:00 2001 From: aguilar1x Date: Sat, 30 Nov 2024 21:29:54 -0600 Subject: [PATCH 7/7] [docs]: add README.md and CONTRIBUTING.md --- CONTRIBUTING.md | 116 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..57640a7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,116 @@ +# **CONTRIBUTING GUIDE BY COFIBLOCKS** ☕ + +Thank you for your interest in contributing to CofiBlocks! We appreciate your time and effort in making our project better. + +This guide will help you get started with contributing to our project. Please note that we have a code of conduct, which we expect all contributors to adhere to. + +## 📝 **Contributing** + +We welcome contributions from the community! Here's how you can help: + +1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account. + + - HERE + +# + +2. **Clone the Fork:** + - Clone the forked repository to your local machine by running the following command: + + ```bash + git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git + ``` + + - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name. + +# + +3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully. + + - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`). + + ``` + git checkout -b branch-name + ``` + - One of ideas on how to implement it for the branch name: + + > `docs/update-readme` or `fix/bottom-bug`. + +# + +4. **Commit:** Commit your changes. + + 1. **git add (file-name)** + 2. **git commit -m "[type] description"** + + - Example: + ``` + git add Create_Documentation + + git commit -m "[docs]: update documentation" + ``` + +# + +5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us. + +- Push your changes to your forked repository: + ```bash + git push origin your-branch-name + ``` + > Replace `your-branch-name` with the name of your branch. + +- Example: + + ```bash + git push origin fix/bug-fix + ``` + +# + +6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. + + - Summit pull request + +# **📁 Commits** + +You can do a regular commit by following the next: + +``` [type] significant message ``` + +- Learn more about conventional commits + +### Type + +Add changes you worked on the issue. + +**Examples:** + +```bash +git commit -m "[docs]: update documentation" +``` + +```bash +git commit -m "[fix]: fix bug in code" +``` + +```bash +git commit -m "[test]: add test case" +``` + +# **🔗 Branches** +1. There must be a `main` branch, used only for the releases. +2. Avoid long descriptive names for long-lived branches. +3. Use kebab-case (no CamelCase). +4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit). +5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow. +6. Use slashes to separate parts of your branch names. +7. Remove your branch after merging it if it is not important. +**Examples:** +``` +git branch -b docs/readme +git branch -b test/a-feature +git branch -b feat/sidebar +git branch -b fix/b-feature +``` +# \ No newline at end of file