Waku.org https://waku.org
Go to file
chair 66a1ef641b
fix typo (#91)
2024-07-29 07:45:12 -07:00
.husky upgrade logos docusaurus preset 2023-06-02 02:49:50 +03:30
.yarn Add bounties box to communites page (#53) 2023-11-06 14:26:20 +11:00
about Update link to Nomos (#89) 2024-07-26 09:30:17 -07:00
root-pages chore: sort news articles order 2024-06-20 17:14:57 +09:00
src fix typo (#91) 2024-07-29 07:45:12 -07:00
static Updating team profile image sources and past events (#87) 2024-06-19 13:55:58 +05:30
.gitignore adds Join Us page (#56) 2023-11-17 15:33:04 +03:30
.prettierignore BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
.prettierrc BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
Jenkinsfile Revert "ci: try to disable shared library polling" 2024-05-15 16:29:17 +02:00
README.md feat: use two deploy branches for CI builds 2024-02-20 10:14:31 +01:00
babel.config.js BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
docusaurus.config.js chore: add contact button 2024-06-06 01:21:48 +09:00
package.json feat: upgrade preset version 2024-06-22 15:35:59 +09:00
tsconfig.json BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
yarn.lock feat: upgrade preset version 2024-06-22 15:35:59 +09:00

README.md

Waku.org

The repository for waku.org website.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/waku-org/waku.org.git
  1. Install the dependencies:
$ yarn install
  1. Start the website:
$ yarn start
  1. Visit http://localhost:3000 in your browser

Landing Page

The code for a landing page is located in src/pages/index.mdx. This file employs the mdx format and utilizes React components from the Logos Docusaurus Plugins package.

Adding Subpages

To include subpages, create a .md or mdx file within the about directory. You can use Frontmatter to add metadata to your markdown file.

The content in about/index.md will be utilized as the index page for the /about section.

Root Pages

Subpages that do not belong to the About page (e.g., Terms of Use) can be situated in the root-pages directory.

Docusaurus Config

You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.

Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.

Custom CSS

By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss.

How to Run a Static Build (Production Build)

  1. Generate static files for production:
$ yarn build

The static files will be created in the build directory.

  1. Serve the static build:
$ yarn serve

CI/CD

The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.

Information about deployed build can be also found in /build.json available on the website.

Change Process

  1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
  2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.
  3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
  4. When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.