93 lines
2.7 KiB
Markdown
93 lines
2.7 KiB
Markdown
# Project Mycelium Website
|
|
|
|
- **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
|
|
|
|
This is the official website for Mycelium Cloud, built using Next.js and Tailwind CSS.
|
|
|
|
---
|
|
|
|
## Technologies
|
|
|
|
- **Framework**: [Next.js](https://nextjs.org/)
|
|
- **Language**: [TypeScript](https://www.typescriptlang.org/)
|
|
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
|
|
|
|
---
|
|
|
|
## 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/`.
|
|
- **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.
|
|
|
|
---
|
|
|
|
## Branding
|
|
|
|
- **Font**: The primary font used is [Mulish](https://fonts.google.com/specimen/Mulish).
|
|
- **Logos**: Project logos are stored in `public/images/logos/`.
|
|
|
|
---
|
|
|
|
## Get Started
|
|
|
|
Follow these steps to get the project running locally:
|
|
|
|
1. **Install Dependencies**:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
2. **Build the Project**:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
3. **Start the Development Server**:
|
|
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
- **Never update the `main` branch directly.** All changes must be reviewed and merged by the team through a pull request.
|
|
- **Always work on the `development` branch.** Create a feature branch from `development` and submit your pull request to `development`.
|
|
- **Request a review.** After submitting your pull request, ask the team to review and accept it into the `main` branch.
|
|
|
|
---
|
|
|
|
## Report an Error
|
|
|
|
To report an issue, please use the following link and provide the requested information:
|
|
|
|
- **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:
|
|
|
|
- **URL**: The page where the error occurred.
|
|
- **Repo**: The repository you are working with.
|
|
- **Branch**: The specific branch you are on.
|
|
- **Problem**: A detailed description of the problem.
|
|
|
|
---
|
|
|
|
## Questions
|
|
|
|
If you have any questions, you can reach out to [sashaastiadi](https://git.ourworld.tf/sashaastiadi).
|