Skip to content

Commit

Permalink
change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@antoinebou12
antoinebou12 committed Nov 1, 2024
1 parent 92ec49e commit f876077
Showing 1 changed file with 193 additions and 51 deletions.
244 changes: 193 additions & 51 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,78 @@
# GRAPHQUON Website

![GitHub last commit](https://img.shields.io/github/last-commit/GRAPHQUON/graphquon.github.io)
![GitHub license](https://img.shields.io/github/license/GRAPHQUON/graphquon.github.io)
![GitHub contributors](https://img.shields.io/github/contributors/GRAPHQUON/graphquon.github.io)
![GitHub last commit](https://img.shields.io/github/last-commit/GRAPHQUON/graphquon.github.io)
![GitHub license](https://img.shields.io/github/license/GRAPHQUON/graphquon.github.io)
![GitHub contributors](https://img.shields.io/github/contributors/GRAPHQUON/graphquon.github.io)
![Website visits](https://img.shields.io/badge/dynamic/json?color=blue&label=Visits&query=value&url=https://api.countapi.xyz/hit/GRAPHQUON/graphquon.github.io)

This repository contains the codebase for the **GRAPHQUON** website, an event hub for the technology and creative industries. Previously known as **MOTOGRAPH**, the site is designed to be flexible and adaptable for future GRAPHQUON events. It is hosted on **GitHub Pages** and automatically deploys from the `main` branch with every push.
Welcome to the **GRAPHQUON** website repository! GRAPHQUON serves as an event hub for the technology and creative industries. Formerly known as **MOTOGRAPH**, our platform is designed to be flexible and easily adaptable for future GRAPHQUON events. Hosted on **GitHub Pages**, the site automatically deploys from the `main` branch with every push, ensuring seamless updates.

---

## 📜 Table of Contents

- [📅 Event Information](#-event-information)
- [🚀 Quick Start](#-quick-start)
- [🛠️ Project Structure](#️-project-structure)
- [🔄 Updating for Future Events](#-updating-for-future-events)
- [💻 Local Development](#-local-development)
- [🚢 Deployment](#-deployment)
- [🛡️ License](#️-license)
- [🤝 Contributing](#-contributing)
- [📞 Contact](#-contact)

---

## 📅 Event Information

For each GRAPHQUON event, the following details are vital to include:
For each GRAPHQUON event, ensure the following details are clearly included:

1. **Where**: The event's location, whether it's a physical venue or an online link for virtual events.
2. **When**: Clear dates and times, with time zones if it's online.
3. **Who**: A list of key speakers, panelists, and hosts to generate interest in the event.
4. **Conversations Over Good Food**: Highlights of any special meal-based networking sessions, such as luncheons, dinners, or coffee breaks, to encourage informal discussions and deeper networking.
1. **Where**: Specify the event's location, whether it's a physical venue or an online platform link for virtual events.
2. **When**: Provide clear dates and times, including time zones for online events.
3. **Who**: List key speakers, panelists, and hosts to generate interest and attract attendees.
4. **Conversations Over Good Food**: Highlight any special meal-based networking sessions, such as luncheons, dinners, or coffee breaks, to encourage informal discussions and deeper networking opportunities.

---

## 🚀 Quick Start

To set up the site locally, you'll need an HTTP server. This will help you avoid CORS issues that might otherwise occur during local testing.
To set up the site locally, follow these steps:

### 1. Install the HTTP Server
### 1. Clone the Repository

Use **npm** to install a basic HTTP server:
```bash
npm install http-server
git clone https://github.com/GRAPHQUON/graphquon.github.io.git
cd graphquon.github.io
```

### 2. Run the Local Server
### 2. Install Dependencies

Ensure you have **npm** installed. Then, install the necessary packages:

Start the server with:
```bash
npm install
```

### 3. Run the Local Server

Start the server to serve the site locally:

```bash
npx http-server
```

Alternatively, you can install `http-server` globally:

```bash
npm install -g http-server
http-server
```

### 3. Access the Site
### 4. Access the Site

Visit `http://localhost:8080` in your browser to see the site in action.
Open your browser and navigate to `http://localhost:8080` to view the site.

> **Tip**: Alternatively, you can use the **Live Server** extension in Visual Studio Code to serve the site locally without additional setup.
> **Tip**: For a more integrated experience, use the **Live Server** extension in Visual Studio Code, which allows you to serve the site locally with live reloading.
---

Expand All @@ -53,68 +83,180 @@ The repository is organized as follows:
```
├── components
│ ├── app.js # Main application component
│ ├── sections/
│ │ ├── about/ # About section component
│ │ ├── contact/ # Contact section component
│ │ ├── footer/ # Footer component
│ │ ├── header/ # Header component
│ │ ├── hero/ # Hero section component
│ │ ├── keynote/ # Keynote section component
│ │ ├── schedule/ # Schedule section component
│ │ ├── terms/ # Terms and conditions section component
│ │ ├── privacy/
├── res/ # Resources (e.g., images, fonts)
├── lib/ # Libraries used in the project
│ ├── background # Background script
│ └── sections
│ ├── about # About
│ ├── contact # Contact
│ ├── footer # Footer
│ ├── header # Header
│ ├── hero # Hero
│ ├── keynote # Keynote
│ ├── privacy # Privacy policy
│ ├── schedule # Event schedule
│ └── terms # Terms and conditions
├── lib # Third-party libraries
│ ├── particles.min.js # Particle effects library
│ └── three.min.js # Three.js library
├── res # Resources (e.g., images, fonts)
├── favicon.png
├── index.html # Main HTML entry point
├── index.js # JavaScript entry point
├── privacy.html # Privacy policy page
└── terms.html # Terms and conditions page
├── index.css # Main CSS stylesheet
├── index.html # Main HTML entry point
├── index.js # JavaScript entry point
├── particles.json # Particle effects configuration
├── privacy.html # Privacy policy page
├── schedule.json # Event schedule data
└── terms.html # Terms and conditions page
```

---

## 🔄 Updating for Future Events

GRAPHQUON’s codebase is built to facilitate easy updates for future events. To tailor the website to a new event:
GRAPHQUON’s codebase is built for easy updates to accommodate future events. To tailor the website for a new event, follow these steps:

1. **Update Content Files**:
- **Homepage**: Modify `index.html` to reflect the new event's details.
- **Event Schedule**: Edit `schedule.json` with the latest event schedule and speaker information.

2. **Update Assets**:
- **Images and Media**: Replace or add new images in the `res/` directory as needed.
- **3D Models and Textures**: Update or add new models and textures in the `components/background/` directory.

- Update content files such as `index.html` for the homepage.
- Edit `schedule.json` to reflect the latest event details.
- Adjust any necessary CSS or style-related files for the new design theme.
3. **Adjust Styles and Themes**:
- Modify `index.css` or other relevant CSS files to update the design theme for the new event.

4. **Review Sections**:
- Ensure all sections in `components/sections/` are up-to-date and relevant to the new event.

5. **Test Locally**:
- Use the [Local Development](#-local-development) steps to preview changes before deploying.

---

## 💻 Local Development

Developing locally is efficient with **npm** and **http-server**. Follow these steps to preview and test changes before pushing them live:
Developing locally allows you to preview and test changes before making them live. Here's how to set up your local development environment:

1. **Clone the Repository**:
```bash
git clone https://github.com/GRAPHQUON/graphquon.github.io.git
cd graphquon.github.io
```

2. **Install Dependencies**:
```bash
npm install
```

1. Modify relevant files, such as `index.html`, event data in `schedule.json`, or stylesheets.
2. Start the server with:
3. **Start the Local Server**:
```bash
npx http-server
```
Or, if installed globally:
```bash
http-server
```
3. Open the site at `http://localhost:8080` in your browser to view the changes in real time.

> **Note**: **Live Server** in Visual Studio Code is a great alternative for a smoother local preview experience.
4. **Open in Browser**:
Navigate to `http://localhost:8080` to view the site.

> **Note**: For live reloading and a smoother development experience, consider using the **Live Server** extension in Visual Studio Code.
5. **Make Changes**:
- Edit HTML, CSS, JavaScript, or JSON files as needed.
- Save your changes and refresh the browser to see updates in real time.

6. **Lint and Test**:
- Ensure your code adheres to project standards.
- Test interactive elements and responsiveness across different devices.

---

## 🚢 Deployment

The site is deployed via **GitHub Pages**. Any push to the `main` branch will automatically redeploy the latest version.
The site is deployed via **GitHub Pages**, ensuring that any push to the `main` branch automatically redeploys the latest version. Follow these steps to deploy your changes:

1. **Commit Your Changes**:
```bash
git add .
git commit -m "Your commit message"
```

2. **Push to GitHub**:
```bash
git push origin main
```

3. **Automatic Deployment**:
- GitHub Pages will detect the push to the `main` branch.
- It will automatically build and deploy the latest version of the site.

4. **Verify Deployment**:
- Visit `https://GRAPHQUON.github.io/graphquon.github.io` to ensure your changes are live.

> **Troubleshooting**:
> - If deployment fails, check the [GitHub Actions](https://github.com/GRAPHQUON/graphquon.github.io/actions) for build logs and error messages.
> - Ensure all dependencies are correctly installed and there are no syntax errors in your code.
---

## 🛡️ License

This project is licensed under the [MIT License](LICENSE). You are free to use, modify, and distribute the code, provided you include the original license and copyright.

---

## 🤝 Contributing

We welcome contributions from the community! To contribute:

**Deployment Steps:**
1. **Fork the Repository**:
- Click the **Fork** button at the top right of the repository page.

1. Commit your changes to your local repository.
2. Push your changes to the `main` branch on GitHub.
3. GitHub Pages will automatically build and deploy the latest version of the site.
2. **Clone Your Fork**:
```bash
git clone https://github.com/your-username/graphquon.github.io.git
cd graphquon.github.io
```

3. **Create a New Branch**:
```bash
git checkout -b feature/your-feature-name
```

4. **Make Your Changes**:
- Implement your feature or bug fix.
- Ensure your code follows the project's coding standards.

5. **Commit Your Changes**:
```bash
git add .
git commit -m "Add your detailed commit message"
```

6. **Push to Your Fork**:
```bash
git push origin feature/your-feature-name
```

7. **Open a Pull Request**:
- Navigate to your fork on GitHub.
- Click **Compare & pull request**.
- Provide a clear description of your changes and submit the pull request.

> **Guidelines**:
> - Ensure your contributions are well-documented.
> - Follow the existing code style and project structure.
> - Test your changes thoroughly before submitting.
---

## 🛡 License
## 📞 Contact

For any questions, suggestions, or support, feel free to reach out:

This project is licensed under the MIT License. For detailed information, refer to the [LICENSE](LICENSE) file in the repository.
- **GitHub Issues**: [Open an Issue](https://github.com/GRAPHQUON/graphquon.github.io/issues)

---

Happy coding and welcome to the world of GRAPHQUON
Happy coding and welcome to the world of **GRAPHQUON**!

0 comments on commit f876077

Please # to comment.