Agora Labs Website

The front facing website for the Agora Labs.

The website is built using Docusaurus and fills the role of landing page and blog.

Table of contents

• 1. Overview
• 2. Requirements
• 3. Setup
  • 3.1. Installations
• 4. Development
  • 4.1. Running locally
• 5. Deployment
  • 5.1. Overview
  • 5.2. Requirements
  • 5.3. Deploy to gh-pages branch
• 6. Miscellaneous
  • 6.1. Useful commands
• 7. License

🔭 1. Overview

TBA...

^{Back to top ^}

📋 2. Requirements

• Install Node v16.14.0
• Install Yarn v1.22.5+

^{Back to top ^}

📦 3. Setup

3.1. Installations

1. Install the Yarn dependencies:

yarn install

^{Back to top ^}

🛠️ 4. Development

4.1. Running locally

1. After the dependencies have been installed, simply run:

yarn start

2. If the page is not opened automatically, navigate to http://localhost:3000.

^{Back to top ^}

🚀 5. Deployment

5.1. Overview

Although the deployment is handled through the CI (GitHub Actions), it is necessary to outline the steps that are involved in the deployment.

^{Back to top ^}

5.2. Requirements

• Install Node v16.14.0
• Install Yarn v1.22.5+

^{Back to top ^}

5.3. Deploy to gh-pages branch

^{Back to top ^}

📑 6. Miscellaneous

6.1. Useful commands

Command	Description
yarn build	builds the static website in the /build directory.
yarn serve	serves the static website from the /build directory.
yarn start	starts a development server that will serve your website and reflect the latest changes on http://localhost:3000.

^{Back to top ^}

📄 7. License

Please refer to the LICENSE file.

^{Back to top ^}