Welcome to the openstoke project. We are dedicated to creating reliable & easily accesibly information regarding open-source, one-wheeled, balance-vehicle devices.
Coming soon!
Coming soon!
The following sections are for people who wish to contribute on a more technical level.
If you're interested in assisting the project from a technical standpoint and have experience with React or NextJS please reach out via discord (link coming soon).
- Node 12.0.0 or greater is required -- 16.13.0 recommended
- NVM is recommended for node version management
- node
16.3.0
is recommended as that is what is used for development. (nvm use 16.3.0
)
- node
To start developing the project run the following:
nvm use 16.3.0
npm install
npm run dev
This project uses styled-components
to style components by using CSS in JS. Read more about styled-components here.
Check out the /styles folder to see constant styles. Please use these styles and add to them when appropriate. This reduces inconsistency across CSS & styles in the app. Here is an example using the fontSizes
from the Type
module of our styles
module.
import styled from 'styled-components'
import { Type } from 'styles'
export const MyContainer = styled.div`
font-size: ${Type.fontSizes.body};
`
You can also use the theme
prop which contains the active theme info (dark and light mode not yet supported but allows us to do so easily in the future):
export const LicenseLink = styled.a`
margin-left: 3px;
&:hover {
path {
fill: ${props => props.theme.brand};
}
}
`
Coming soon!
Coming soon!
[slug].js
generates static paths usinggetStaticPaths
from all.mdx
files located in the specified directory (content/
by default).- The
getStaticProps
NextJS method passes the MDX content including front-matter (parsed with gray-matter) to the<PostPage />
component to be rendered. - The index or home page uses similar logic to generate a list of posts sorted by date.
Statically generated guides & wiki based on file system within Git repo.
- [] Release rough V1
- [] More goals TODO
Project is licensed under MIT license. See LICENSE.md for more info.