sashaastiadi/www_mycelium
1
0
Fork 2
forked from hero/www_hero_project
Code Pull Requests Activity

add readme

Browse Source
This commit is contained in:
sasha-astiadi 2024-08-20 15:14:59 +02:00
parent ea3c46c928
commit bbcab83fba
1 changed files with 51 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
readme.md
View File

@ -1,33 +1,44 @@
# Your Website # TF9 Website
![](../static/images/logo.png) Welcome to the official repository for the **TF9** website, accessible at [www.tf9.io](https://www.tf9.io). This site serves as the digital front for TF9, providing information, resources, and access to the latest developments within the ThreeFold community.
## About ## Project Overview
The TF9 website is built using modern, efficient web technologies to ensure a seamless user experience. The stack includes:
- **Zola**: A fast, static site generator designed for simplicity and performance.
- **Tailwind CSS**: A utility-first CSS framework for rapid UI development.
- **JavaScript**: Enhancing interactivity and functionality on the website.
## Environments
The TF9 website is deployed across two environments:
- **Production**:
- **Branch**: `main`
- **URL**: [www.tf9.io](https://www.tf9.io)
- **Development**:
- **Branch**: `dev`
- **URL**: [www2.tf9.io](https://www2.tf9.io)
## Installation
To get started with the development environment, ensure that you have the following installed on your machine:
1. **Zola**: [Installation Guide](https://www.getzola.org/documentation/getting-started/installation/)
2. **Tailwind CSS**: [Installation Guide](https://tailwindcss.com/docs/installation)
3. **Node.js & npm**: Required for managing JavaScript dependencies.
The official website of **your website***
## Getting Started ## Getting Started
### Fork the Repository Once these dependencies are installed, you can clone this repository and navigate into the project directory:
On the top right corner of the repository page, you will see a button labeled "Fork." Click on it. This action will create a copy of the template repository in your GitHub account. ```bash
git clone https://git.ourworld.tf/tfcoop/www_tf9_new
cd www_tf9_new
### Clone the Forked Repository
After forking, go to your GitHub profile, and you should see the forked repository listed there. Click on it. On the right side, you will find a green button labeled "Code." Click on it, and you can either download the repository as a ZIP file or use Git to clone it to your local machine.
## Replace Template Images
USE IMAGE TEMPLATE ON: [FIGMA](https://www.figma.com/file/ZOf117YaHS3Gg3IJOvSIZ4/photo-templates?type=design&node-id=0%3A1&mode=design&t=WeavsHLNVCNYNoJg-1)
Access the provided image template by clicking on the link provided. The template is designed with a fixed format for images, and its layout includes predefined image frames with clear instructions for each section. Familiarize yourself with the template's structure and layout before proceeding.
Replace the existing image frames in the figma template with your own images, ensuring that they match the specified dimensions and aspect ratios to maintain responsiveness.
### Customizing Your Website
Export the images from figma files on the new repository. Detailed instructions are provided within the figma file.
Customize the content as needed to align with your website's theme and purpose, following the instructions within the file. After making these changes, export the images as image files. Be sure to follow any additional guidelines provided in the template file for optimization.
### Reviewing New Website Changes Locally ### Reviewing New Website Changes Locally
@ -45,25 +56,32 @@ Wait for the Localhost URL: The start script will initiate a local development s
### Open the URL in Your Browser ### Open the URL in Your Browser
Once the localhost URL is generated, open your web browser and enter the provided URL (e.g., http://localhost:xxxx). This will display your website locally, allowing you to review the changes you made. Once the localhost URL is generated, open your web browser and enter the provided URL (e.g., http://localhost:xxxx). This will display your website locally, allowing you to review the changes you made.
### Publishing New Website ## Contributing
To publish your website with [ThreeFold's Operations team](https://github.com/threefoldtech/tf_operations/issues), create a new issue in their GitHub repository here, specifying your preferred domains. They will guide you through the process of domain allocation and setting up your site. Once it's live, test it thoroughly, and feel free to reach out for further support or updates. We welcome contributions from the community! To contribute:
Feel free to [create a new issue](your repo) to report an error on the website, or if you have any suggestions on website improvements. Create a new branch (git checkout -b feature/your-feature-name).
Make your changes and commit them (git commit -m 'Add new feature').
Push to the branch (git push origin feature/your-feature-name).
Open a Pull Request.
# Welcome to your Repository ## Issues and Suggestions
- Website Name: your website We welcome feedback, bug reports, and feature requests to help improve the TF9 website. If you encounter any issues or have suggestions, please follow the steps below:
- Brief Description: This is the official website of yourwebsite.
Last Updated: March 2023
- Website URL: yourwebsite 1. Go to the **TF Web Presence project** board on Gitea: [Project](https://git.ourworld.tf/tfgrid/circle_web_presence/projects/35)
2. Click on the "New Issue" button.
3. Provide a clear title and detailed description of the issue or suggestion.
4. Add relevant labels, milestones, or assignees if applicable.
5. Submit the issue.
Our team will review and address your submission as soon as possible.
Thank you for helping us improve TF9!
- For any suggestions or improvement ideas please
Create an issue on: repo
## Administrators ## Administrators
[ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) [ThreeFold's Web Presence Team](https://git.ourworld.tf/tfgrid/circle_web_presence/)
## Website Maintenance ## Website Maintenance