Waku.org https://waku.org
Go to file
Jakub Sokołowski b0ff826302 ci: add genaration of build.json matadate file
Useful for debugging missing deployments. Result:
```
 > curl -sL dev.waku.org/build.json

```

Signed-off-by: Jakub Sokołowski <jakub@status.im>
2024-02-19 23:14:18 +09: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 fix: fix bug with file extension 2023-12-11 18:55:29 +09:00
root-pages chore: update terms and privacy policy 2024-02-19 22:54:34 +09:00
src feat: add eth denver event draft page 2024-01-31 16:35:54 +09:00
static adding ETHLATAM to events 2024-02-19 20:12:10 +09:00
.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 ci: add genaration of build.json matadate file 2024-02-19 23:14:18 +09:00
README.md docs: update README 2023-09-06 00:26:57 +09:00
babel.config.js BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
docusaurus.config.js chore: update fathom scriptUrl 2024-02-14 20:48:36 +09:00
package.json chore: upgrade fathom plugin 2024-02-14 05:46:52 +09:00
tsconfig.json BREAKING CHANGE: implement docusaurus (#36) 2023-06-01 21:48:43 +01:00
yarn.lock chore: upgrade fathom plugin 2024-02-14 05:46:52 +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 master branch is automatically deployed to the production server (e.g., logos.co) through CI
  • The develop branch is automatically deployed to the staging server (e.g., dev.logos.co) through CI

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.