From f4519ec8bf7fa331a2f89b572a176ded5dcca7d4 Mon Sep 17 00:00:00 2001 From: sashaastiadi Date: Wed, 15 Oct 2025 09:55:00 +0000 Subject: [PATCH 1/4] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b5ad07..8e91faf 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Mycelium Cloud Website -- **Main Branch:** [https://project.mycelium.tf/](https://project.mycelium.tf/) -- **Dev Branch:** [https://www2.project.mycelium.tf/](https://www2.project.mycelium.tf/) - **Repository:** [https://git.ourworld.tf/ourworld_web/www_project_mycelium/](https://git.ourworld.tf/ourworld_web/www_project_mycelium/) +- **Main Branch (Production):** [https://project.mycelium.tf/](https://project.mycelium.tf/) +- **Dev Branch (Staging):** [https://www2.project.mycelium.tf/](https://www2.project.mycelium.tf/) + + --- ## About @@ -72,7 +74,9 @@ Follow these steps to get the project running locally: To report an issue, please use the following link and provide the requested information: -- **Issue Tracker**: [https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues](https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues) +- **Issue Tracker**: [https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues](https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues) and tag **OW Website & Wiki Project 2025** + +- See the current web rpoject on [OW Website & Wiki Project 2025](https://git.ourworld.tf/ourworld_web/-/projects/153) When reporting an issue, please include: From 1577eb6c6c828a924eacb1c483fa4a78f28039ee Mon Sep 17 00:00:00 2001 From: sashaastiadi Date: Wed, 15 Oct 2025 09:56:06 +0000 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e91faf..62f7c68 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Follow these steps to get the project running locally: To report an issue, please use the following link and provide the requested information: -- **Issue Tracker**: [https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues](https://git.ourworld.tf/tfgrid_internal/circle_tfgrid_ops/issues) and tag **OW Website & Wiki Project 2025** +- **Issue Tracker**: [git.ourworld.tf/ourworld_web/HOME/issues/new](https://git.ourworld.tf/ourworld_web/HOME/issues/new) and tag **OW Website & Wiki Project 2025** - See the current web rpoject on [OW Website & Wiki Project 2025](https://git.ourworld.tf/ourworld_web/-/projects/153) From 1c2c27484895cd1176c3259f004cd685c818202b Mon Sep 17 00:00:00 2001 From: sashaastiadi Date: Wed, 15 Oct 2025 10:37:16 +0000 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 62f7c68..de14038 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Mycelium Cloud Website +# Project Mycelium Website - **Repository:** [https://git.ourworld.tf/ourworld_web/www_project_mycelium/](https://git.ourworld.tf/ourworld_web/www_project_mycelium/) From 3f86c7e87f8a552fba52c8512ad5379ea21510d1 Mon Sep 17 00:00:00 2001 From: sasha-astiadi Date: Mon, 20 Oct 2025 13:55:50 +0200 Subject: [PATCH 4/4] docs: add development guide and dependencies section to README --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index de14038..5e10778 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,19 @@ This is the official website for Mycelium Cloud, built using Next.js and Tailwin --- +## Dependencies + +- **UI**: [@headlessui/react](https://headlessui.com/) +- **Animation**: [framer-motion](https://www.framer.com/motion/) +- **Utilities**: [clsx](https://github.com/lukeed/clsx), [use-debounce](https://github.com/xnimorz/use-debounce) + +--- + ## File Structure - **Pages**: To edit the content of a specific page, navigate to `src/app/(main)/`. - **Components**: Reusable components are located in `src/components/`. -- **Images and Videos**: Add or modify images and videos in the `public/` directory. Images are in `public/images/` and videos are in `public/videos/`. +- **Images**: Add or modify images in the `public/images/` directory. - **CSS**: Global styles can be found in `src/styles/tailwind.css`. Most styling is done using Tailwind CSS utility classes directly in the `.tsx` files. --- @@ -62,6 +70,57 @@ Follow these steps to get the project running locally: --- +## Development Guide + +This project follows a modular, component-based architecture. Pages are assembled by combining reusable components into a single layout. + +### Homepage Structure + +The homepage (`src/app/(main)/page.tsx`) is composed of the following components: + +- `HomeHero` +- `WorldMap` +- `StackSectionPreview` +- `Steps` +- `Companies` +- `ClickableGallery` +- `BentoReviews` +- `CallToAction` + +To edit a specific section of the homepage, navigate to `src/components/` and modify the corresponding component file. + +### Base Layout + +The main layout for the application is defined in `src/components/Layout.tsx`. This file includes the `Header` and `Footer` and wraps the primary content of each page. + +### Creating a New Page + +To create a new page, follow these steps: + +1. **Create a Folder**: Inside the `src/app/(main)/` directory, create a new folder with the desired URL slug for your page (e.g., `new-page`). + +2. **Create the Page File**: Inside the new folder, create a `page.tsx` file. + +3. **Add Page Content**: Compose your page by importing and using the reusable components from `src/components/`. For example: + + ```tsx + import { HomeHero } from '@/components/HomeHero' + import { Faqs } from '@/components/Faqs' + + export default function NewPage() { + return ( + <> + + + + ) + } + ``` + +The new page will be accessible at `http://localhost:3000/new-page`. + +--- + ## Contributing - **Never update the `main` branch directly.** All changes must be reviewed and merged by the team through a pull request.