add readme
This commit is contained in:
parent
b06469b9dc
commit
c8e9a64dc8
99
README.md
99
README.md
@ -2,7 +2,7 @@
|
||||
|
||||
- Website Name: OurWorld
|
||||
- Brief Description: This is the official website of OurWorld.
|
||||
Last Updated: March 2023
|
||||
Last Updated: Aug 2024
|
||||
|
||||
- production(master branch) https://ourworld.tf/
|
||||
- staging(development branch) https://www2.ourworld.tf/
|
||||
@ -10,32 +10,81 @@ Last Updated: March 2023
|
||||
- For any suggestions or improvement ideas please
|
||||
Create an issue on: https://github.com/threefoldfoundation/www_ourworld_tf/issues
|
||||
|
||||
## Administrators
|
||||
[ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin)
|
||||
## Project Overview
|
||||
|
||||
## Contribution Procedure
|
||||
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.
|
||||
- **Markdown**: Used for writing content in a simple and readable format, which Zola converts into HTML.
|
||||
- **HTML**: The backbone of the web pages, structuring the content and defining the layout of the website.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
Once these dependencies are installed, you can clone this repository and navigate into the project directory:
|
||||
|
||||
```bash
|
||||
git clone https://git.ourworld.tf/tfcoop/www_tf9_new
|
||||
cd www_tf9_new
|
||||
|
||||
```
|
||||
|
||||
### Reviewing New Website Changes Locally
|
||||
|
||||
#### Access the Terminal
|
||||
Within your code editor, open the terminal or command line interface. Make sure you are in the root directory of your website project in the terminal.
|
||||
|
||||
#### Run the Build Script:
|
||||
Type **./build.sh** in the terminal and press Enter. This script is responsible for building or compiling your website code and assets.
|
||||
|
||||
#### Run the Start Script:
|
||||
After the build process is complete, type **./start.sh** in the terminal and press Enter. This script typically starts a local development server.
|
||||
|
||||
Wait for the Localhost URL: The start script will initiate a local development server, and it will display a localhost URL, such as **http://localhost:xxxx**, where xxxx is a port number. Wait for this URL to be generated.
|
||||
|
||||
### 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.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions from the community! To contribute:
|
||||
|
||||
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.
|
||||
|
||||
## Issues and Suggestions
|
||||
|
||||
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:
|
||||
|
||||
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!
|
||||
|
||||
|
||||
## Administrators
|
||||
[ThreeFold's Web Presence Team](https://git.ourworld.tf/tfgrid/circle_web_presence/)
|
||||
|
||||
## Website Maintenance
|
||||
|
||||
|
||||
|
||||
It is highly important to follow this procedure to contribute to the website content. <br>
|
||||
__WARNING__: DO NOT commit straight into __master__ / __development__ branch.
|
||||
|
||||
1. Create an Issue
|
||||
Feel free to [create a new issue](https://github.com/threefoldfoundation/www_threefold_io/issues/new) to report an error on the website, or if you have any suggestions on website improvements.
|
||||
|
||||
2. Make your own branch from __'development'__ branch.
|
||||
by creating a new branch from 'Master' you will be provided with the latest copy of the live website content.
|
||||
|
||||
3. Add your edits into your own branch via code editor locally, and push your local changes online. WARNING: DO NOT add your edits straight into __master__ / __development__ branch.
|
||||
|
||||
5. Create a PR to merge your own branch into '**development**', and assign one of [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) on your PR as reviewer, or assign @sasha-astiadi as reviewer.
|
||||
|
||||
7. When PR is approved, you can see your changes on staging env on www2.threefold.io (development branch)
|
||||
|
||||
8. Admin will then create a PR to merge 'development' into into '**maste**r' (production branch)
|
||||
|
||||
10. When PR is approved, you can see your changes live on production (master branch).
|
||||
|
||||
|
||||
|
||||
|
||||
__WARNING__: DO NOT commit straight into __master__ / __development__ branch.
|
||||
Reference in New Issue
Block a user