Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 2.83 KB

GettingStarted.stories.mdx

File metadata and controls

72 lines (44 loc) · 2.83 KB
Raw

import { Meta } from "@storybook/blocks";

Getting Started

Thanks for supporting Odyssey. This is the Quick Start guide you should read first.

Requirements

Husky Config

Please add this to ~/.huskyrc to use Odyssey with Git tooling such as GitKraken:

#!/usr/bin/env bash
source ~/.zshrc

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

if test -f ".nvmrc"; then
  nvm use
fi

In this case, the config is referencing the ~/.zshrc file. If you're using bash, then reference ~/.bashrc instead.

Code of Conduct

Odyssey has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it.

Please read the full text so that you can understand what actions will and will not be tolerated.

Have questions?

If you have questions about Odyssey, be sure to check out the hosted documentation where we have several examples and detailed API references that may help you solve your problem. Oktanauts contact can contact our team in slack.

Here to contribute?

There are many ways to contribute to the project. Code is just one possible means of contribution.

  • Feedback. Tell us what we're doing well or where we can improve.
  • Support. You can answer questions on Slack or GitHub Pull Requests.
  • Write. If you come up with an interesting example, write about it. Post it online and share it with us. We'd love to see what folks in the community build with Odyssey!
  • Report. Create new issues or bug reports so that we can make Odyssey even better.

How to build and share Odyssey code examples?

How to develop against the Odyssey project itself?

How to open a good pull request?

How do I solve X problem for Odyssey?

heuristic /ˌhjʊ(ə)ˈrɪstɪk/

A technique designed for solving a problem more quickly when classic methods are too slow, or for finding an approximate solution when classic methods fail to find any exact solution

  • Code should be easy to reason about
  • Code should be easy to delete
  • Avoid early abstractions
  • Avoid thinking too far into the future
  • Complexity should be introduced when it is inevitable