Compare commits
8 Commits
74d5bae622
...
developmen
| Author | SHA1 | Date | |
|---|---|---|---|
| 28bef26fbc | |||
| 73fe0e7c8e | |||
| c59c09eee8 | |||
| 75b660d81e | |||
| 3f86c7e87f | |||
| 1c2c274848 | |||
| 1577eb6c6c | |||
| f4519ec8bf |
73
README.md
73
README.md
@@ -1,9 +1,11 @@
|
|||||||
# Mycelium Cloud Website
|
# Project Mycelium 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/)
|
- **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
|
## About
|
||||||
@@ -20,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
|
## File Structure
|
||||||
|
|
||||||
- **Pages**: To edit the content of a specific page, navigate to `src/app/(main)/`.
|
- **Pages**: To edit the content of a specific page, navigate to `src/app/(main)/`.
|
||||||
- **Components**: Reusable components are located in `src/components/`.
|
- **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.
|
- **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.
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -60,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 (
|
||||||
|
<>
|
||||||
|
<HomeHero />
|
||||||
|
<Faqs />
|
||||||
|
</>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The new page will be accessible at `http://localhost:3000/new-page`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
- **Never update the `main` branch directly.** All changes must be reviewed and merged by the team through a pull request.
|
- **Never update the `main` branch directly.** All changes must be reviewed and merged by the team through a pull request.
|
||||||
@@ -72,7 +133,9 @@ Follow these steps to get the project running locally:
|
|||||||
|
|
||||||
To report an issue, please use the following link and provide the requested information:
|
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**: [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)
|
||||||
|
|
||||||
When reporting an issue, please include:
|
When reporting an issue, please include:
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ export default function Home() {
|
|||||||
<section id="technologies">
|
<section id="technologies">
|
||||||
<StackSectionPreview />
|
<StackSectionPreview />
|
||||||
</section>
|
</section>
|
||||||
<section id="deploy">
|
<section id="how-it-works">
|
||||||
<Steps />
|
<Steps />
|
||||||
</section>
|
</section>
|
||||||
<section id="llms">
|
<section id="llms">
|
||||||
@@ -39,7 +39,7 @@ export default function Home() {
|
|||||||
<section id="bento-reviews">
|
<section id="bento-reviews">
|
||||||
<BentoReviews />
|
<BentoReviews />
|
||||||
</section>
|
</section>
|
||||||
<section id="call-to-action">
|
<section id="get-started">
|
||||||
<CallToAction />
|
<CallToAction />
|
||||||
</section>
|
</section>
|
||||||
</>
|
</>
|
||||||
|
|||||||
@@ -23,12 +23,7 @@ export function CallTo() {
|
|||||||
Book a Meeting
|
Book a Meeting
|
||||||
</a>
|
</a>
|
||||||
<a
|
<a
|
||||||
href="javascript:;"
|
href="mailto:info@ourworld.tf"
|
||||||
onClick={() => {
|
|
||||||
if (typeof window !== 'undefined' && (window as any).ml_account) {
|
|
||||||
(window as any).ml_account('webforms', '6108375', 'l9m8g1', 'show')
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
className="text-sm/6 font-semibold text-[#2F3178] hover:text-[#2F3178]/80"
|
className="text-sm/6 font-semibold text-[#2F3178] hover:text-[#2F3178]/80"
|
||||||
>
|
>
|
||||||
Join the Waitlist <span aria-hidden="true">→</span>
|
Join the Waitlist <span aria-hidden="true">→</span>
|
||||||
|
|||||||
@@ -47,11 +47,7 @@ export function CallToAction() {
|
|||||||
<Button
|
<Button
|
||||||
variant="outline"
|
variant="outline"
|
||||||
color="white"
|
color="white"
|
||||||
onClick={() => {
|
href="mailto:info@ourworld.tf"
|
||||||
if (typeof window !== 'undefined' && (window as any).ml_account) {
|
|
||||||
(window as any).ml_account('webforms', '6108375', 'l9m8g1', 'show')
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
>
|
>
|
||||||
Join the Waitlist
|
Join the Waitlist
|
||||||
</Button>
|
</Button>
|
||||||
|
|||||||
@@ -113,11 +113,7 @@ export function Header() {
|
|||||||
<Button
|
<Button
|
||||||
variant="outline"
|
variant="outline"
|
||||||
color="white"
|
color="white"
|
||||||
onClick={() => {
|
href="mailto:info@ourworld.tf"
|
||||||
if (typeof window !== 'undefined' && (window as any).ml_account) {
|
|
||||||
(window as any).ml_account('webforms', '6108375', 'l9m8g1', 'show')
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
>
|
>
|
||||||
Join the Waitlist
|
Join the Waitlist
|
||||||
</Button>
|
</Button>
|
||||||
@@ -134,11 +130,7 @@ export function Header() {
|
|||||||
<Button
|
<Button
|
||||||
variant="outline"
|
variant="outline"
|
||||||
color="white"
|
color="white"
|
||||||
onClick={() => {
|
href="mailto:info@ourworld.tf"
|
||||||
if (typeof window !== 'undefined' && (window as any).ml_account) {
|
|
||||||
(window as any).ml_account('webforms', '6108375', 'l9m8g1', 'show')
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
>
|
>
|
||||||
Join the Waitlist
|
Join the Waitlist
|
||||||
</Button>
|
</Button>
|
||||||
|
|||||||
Reference in New Issue
Block a user