This commit is contained in:
2025-09-19 14:14:04 +02:00
parent 017fc41d2b
commit 9a4f347ee8

View File

@@ -1,35 +1,83 @@
# Mycelium
# Mycelium Cloud Website
Mycelium is a [Tailwind Plus](https://tailwindcss.com/plus) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
This is the official website for Mycelium Cloud, built using Next.js and Tailwind CSS.
## Getting started
## Getting Started
To get started with this template, first install the npm dependencies:
Follow these instructions to get a local copy up and running for development and testing purposes.
```bash
npm install
```
### Prerequisites
Next, run the development server:
Make sure you have Node.js and npm installed on your machine. You can download them from [nodejs.org](https://nodejs.org/).
### Installation
1. Clone the repository to your local machine.
2. Install the NPM packages:
```bash
npm install
```
### Running the Application
To run the development server:
```bash
npm run dev
```
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
## Customizing
## Git Workflow
You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
We follow a branching model to ensure code quality and a stable production environment. All new work should be done on a feature branch.
1. **Switch to the `development` branch** and make sure it's up to date:
```bash
git checkout development
git pull origin development
```
2. **Create a new feature branch** for your changes:
```bash
git checkout -b your-feature-name
```
3. **Make your changes and commit them**.
4. **Push your feature branch** to the remote repository:
```bash
git push origin your-feature-name
```
5. **Create a Pull Request** on GitHub from your feature branch to the `development` branch.
6. After the pull request is reviewed and merged, the changes will be on the `development` branch. To deploy to production, the `development` branch will be merged into `main`.
## Project Structure
Here is an overview of the key directories in the project:
- `src/app/(main)/page.tsx`
This is the main entry point for the homepage.
- `src/components/`
This directory contains all the reusable React components used throughout the site. The main components rendered on the homepage (`src/app/(main)/page.tsx`) are:
- `HomeHero.tsx`
- `StackSection.tsx` (as `StackSectionPreview`)
- `BentoReviews.tsx`
- `WorldMap.tsx`
- `Steps.tsx`
- `Companies.tsx`
- `ClickableGallery.tsx`
- `CallToAction.tsx`
- `public/images/`
All static images are stored here. You can find logos, gallery images, and other visual assets in this folder.
- `public/videos/`
This folder contains video assets used on the site.
## License
This site template is a commercial product and is licensed under the [Tailwind Plus license](https://tailwindcss.com/plus/license).
## Learn more
To learn more about the technologies used in this site template, see the following resources:
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation