Go to file
Jakub Sokołowski 8287d71f4e
ci: fix Jenkinsfile, update readme
Signed-off-by: Jakub Sokołowski <jakub@status.im>
2024-05-08 17:31:25 +02:00
.github bootstrap project 2024-05-01 19:11:28 +09:00
.husky bootstrap project 2024-05-01 19:11:28 +09:00
root-pages Update index.mdx 2024-05-02 14:57:45 +02:00
src feat: add cta button 2024-05-02 19:12:16 +09:00
static/img bootstrap project 2024-05-01 19:11:28 +09:00
.gitignore bootstrap project 2024-05-01 19:11:28 +09:00
.prettierignore bootstrap project 2024-05-01 19:11:28 +09:00
.prettierrc bootstrap project 2024-05-01 19:11:28 +09:00
Jenkinsfile ci: fix Jenkinsfile, update readme 2024-05-08 17:31:25 +02:00
README.md ci: fix Jenkinsfile, update readme 2024-05-08 17:31:25 +02:00
babel.config.js bootstrap project 2024-05-01 19:11:28 +09:00
docusaurus.config.js chore: update footer content 2024-05-01 19:21:18 +09:00
package.json bootstrap project 2024-05-01 19:11:28 +09:00
tsconfig.json bootstrap project 2024-05-01 19:11:28 +09:00
yarn.lock bootstrap project 2024-05-01 19:11:28 +09:00

README.md

assembly.logos.co

The repository for assembly.logos.co website.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/assembly.logos.co.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.