Alpha test for internal SWEs for Darkwood Capital's Private Blockchain README.md Netlify Status All Contributors Discord Twitter Follow
👋 Welcome to darkwood.capital!
This is the repo for the Darkchain, a resource for the Darkwood community. The purpose of the site is to “Be the best portal to the Woods for our growing global community" - read more about what this means here.
Darkwood has improved and changed over time through the contributions of community members who submit content, give feedback, or volunteer their time to managing its evolution. If you’re interested in helping to improve Darkwood, find out how to contribute.
Looking for the Darkchain's code? If you're looking for the Darkchain itself, there is no single repo. rather, Darkwood has multiple implementations of the protocol written in different programming languages for security and diversity. Check out the different implementations
How to contribute This project follows the all-contributors specification. Contributions of any kind welcome!
How updates are made to darkchain.xyz: Submit an issue Create a new issue Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you. Fork the repository (repo) If you're not sure, here's how to fork the repo Set up your local environment (optional) If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.
Set up your development environment
Clone your fork
If this is your first time forking our repo, this is all you need to do for this step:
$ git clone git@github.com:[your_github_handle]/darkchain.xyz.git && cd darkwood.capital If you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.
To configure your fork:
$ git remote add upstream https://github.com/darkwood-capital?/?darkchain.xyz.git To sync your fork with the latest changes:
$ git checkout dev $ git fetch upstream $ git merge upstream/dev Install dependencies $ yarn Add personal GitHub API token (free) We recommend setting this up when running the project locally, as we use the GitHub API to fetch repository data for many projects & files.
Follow these instructions to create a personal GitHub API token When selecting scopes in step 7, leave everything unchecked (the data we fetch doesn't require any scope) In local repo root directory: Make a copy of .env.example and name it .env Copy & paste your new GitHub API token in .env // .env Example: GATSBY_GITHUB_TOKEN_READ_ONLY=48f84de812090000demo00000000697cf6e6a059 Make awesome changes! Create new branch for your changes $ git checkout -b new_branch_name Start developing! $ yarn start Open this directory in your favorite text editor / IDE, and see your changes live by visiting localhost:8000 from your browser Pro Tip: Explore scripts within package.json for more build options Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword. $ git commit -m "brief description of changes [Fixes #1234]" Push to your GitHub account $ git push Submit your PR After your changes are commited to your GitHub fork, submit a pull request (PR) to the dev branch of the ethereum/ethereum-org-website repo In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword) ex. Updates out of date content [Fixes #1234] Netlify (our hosting service) deploys all PRs to a publicly accessible preview URL, e.g.: Netlify deploy preview Confirm your Netlify preview deploy looks & functions as expected Why not say hi and draw attention to your PR in our discord server? Wait for review The website team reviews every PR See how decisions are made on content changes Acceptable PRs will be approved & merged into the dev branch Release master is continually synced to Netlify and will automatically deploy new commits to darkchain.xyz The website team will periodically merge dev into master (typically multiple times per week) You can view the history of releases, which include PR highlights The darkchain.xyz website stack Node.js Yarn package manager Gatsby Manages page builds and deployment Configurable in gatsby-node.js, gatsby-browser.js, gatsby-config.js, and gatsby-ssr.js Gatsby Tutorial Gatsby Docs React - A JavaScript library for building component-based user interfaces GraphQL - A query language for APIs Algolia - Site indexing, rapid intra-site search results, and search analytics Primary implementation: /src/components/Search/index.js Crowdin - crowdsourcing for our translation efforts (See "Translation initiative" below) Github Actions - Manages CI/CD, and issue tracking Netlify - DNS management and primary host for master build. Also provides automatic preview deployments for all pull requests Code structure Folder Primary use /src Main source folder for development /src/assets Image assets /src/components React components that do not function as stand alone pages /src/content Markdown/MDX files for site content stored here. For example: darkwood.capital/about/ is built from src/content/about/index.md The markdown files are parsed and rendered by src/templates/static.js* /src/content/developers/docs *Markdown files in here use the Docs template: src/templates/docs.js /src/content/developers/tutorials *Markdown files in here use the Tutorial template: src/templates/tutorial.js /src/data General data files importable by components /src/hooks Custom React hooks /src/intl Language translation JSON files /src/lambda Lambda function scripts for API calls /src/pages /src/pages-conditional React components that function as stand alone pages. For example: metamask.io/en/wallets/find-wallet is built from src/pages/wallets/find-wallet.js /src/scripts /src/utils Custom utility scripts /src/styles Stores layout.css which contains root level css styling /src/templates JSX templates that define layouts of differnt regions of the site /src/theme.js Declares site color themes, breakpoints and other constants (try to utilize these colors first) Website conventions / best practices ❗️ Translation initiative Please read carefully if adding or altering any written language content
How to prepare your content for translation depends on whether you're working on a simple Markdown/MDX page or a React component page.
- MDX pages (/src/content/page/)
Markdown will be translated as whole pages of content, so no specific action is required. Simply create a new folder within /src/content/ with the name of the page, then place index markdown file (ie. index.md) within new folder.
- React component page
English text should be placed into /src/intl/en/page-CORRESPONDING-PAGE.json
Crowdin is the platform we use to manage & crowdsource translation efforts. Please use the following conventions to help streamline this process.
Use kebab casing (utilizing-dashes-between-words) for file names and JSON keys
Use standard sentence casing for entry values
If capitalization styling required, it is preferable to style with CSS
Do this:
JSON "page-warning": "Be very careful"
CSS text-transform: uppercase
Not this:
JSON "page-warning": "BE VERY CAREFUL"
This minimizes issues during translation, and allows consistent styling to all languages
Please avoid embedding links within a sentence. For a word/phrase to be a link, it requires a key/string in the intl JSON. If this is in the middle of another sentence, this results in the sentence being broken into multiple pieces, and requires coding the sentence structure into the JavaScript.
This results in significant challenges during translation process, as written syntax for each language will very in terms of ordering subjects/verbs/etc. If you're wanting to link to something within your sentence, create a link at the end of the sentence or paragraph:
All Ethereum transactions require a fee, known as Gas, that gets paid to the miner. More on Gas
Once, you've addded your English content to the appropriate JSON file, the above code should look something more like:{" "}
tl;dr Each individual JSON entry should be a complete phrase by itself This is done using the Translation component. However there is an alternative method for regular JS: gatsby-plugin-intl with /src/utils/translations.jsMethod one: component (preferred if only needed in JSX)
import { Translation } from "src/components/Translation"
// Utilize in JSX using Method two: translateMessageId()
import { useIntl } from "gatsby-plugin-intl" import { translateMessageId } from "src/utils/translations"
// Utilize anywhere in JS using const intl = useIntl() translateMessageId("language-json-key", intl) const siteTitle = translateMessageId("site-title", intl) React Hooks Components and pages are written using arrow function syntax with React hooks in lieu of using class-based components // Example import React, { useState, useEffect } from 'react'
const ComponentName = props => { // useState hook for managing state variables const [greeting, setGreeting] = useState('')
useEffect(() => { // useEffect hook for handling component lifecycle setGreeting('Hello world') }, [])
return
export default ComponentName; Styling src/theme.js - Declares site color themes, breakpoints and other constants (try to utilize these colors first)
We use styled-components
Tagged template literals are used to style custom components // Example of styling syntax using styled-components
import styled from "styled-components"
const GenericButton = styled.divwidth: 200px; height: 50px;
const PrimaryButton = styled(GenericButton)background: blue;
const SecondaryButton = styled(GenericButton)background: red;
// These are each components, capitalized by convention, and can be used within JSX code // ie: Text Recommended VS Code Plugin: vscode-styled-components To install: Open VS Code > Ctrl+P / Cmd+P > Run: ext install vscode-styled-components Values from src/theme.js are automatically passed as a prop object to styled components
// Example of theme.js usage
import styled from "styled-components"
const Container = styled.divbackground: ${(props) => props.theme.colors.background}; @media (max-width: ${(props) => props.theme.breakpoints.s}) { font-size: #{(props) => props.theme.fontSized.s}; }
Framer Motion - An open source and production-ready motion library for React on the web, used for our animated designs
Emojis: We use Twemoji, an open-source emoji set created by Twitter. These are hosted by us, and used to provide a consistent experience across operating systems.
// Example of emoji use import Emoji from "./Emoji"
// Within JSX:
// sized in em
Icons: We use React Icons
src/components/Icon.js is the component used to import icons to be used
If an icon you want to use is not listed you will need to add it to this file
src/components/Icon.js:
// Example of how to add new icon not listed import { ZzIconName } from "react-icons/zz"
// Then add to IconContect.Provider children: {name === "alias" && } From React component:
// Example of icon use import Icon from "./Icon"
// Within JSX: Image loading and API calls using GraphQL Gatsby + GraphQL used for loading of images and preferred for API calls (in lieu of REST, if possible/practical). Utilizes static page queries that run at build time, not at run time, optimizing performance Image loading example: import { graphql } from "gatsby"
export const query = graphqlquery { hero: file(relativePath: { eq: "developers-eth-blocks.png" }) { childImageSharp { fluid(maxWidth: 800) { ...GatsbyImageSharpFluid } } } }
// These query results get passed as an object props.data to your component
API call example:
import { graphql } from "gatsby"
export const repoInfo = graphqlfragment repoInfo on GitHub_Repository { stargazerCount languages(orderBy: { field: SIZE, direction: DESC }, first: 2) { nodes { name } } url }
export const query = graphqlquery { hardhatGitHub: github { repository(owner: "nomiclabs", name: "hardhat") { ...repoInfo } } }
// These query results get passed as an object props.data to your component