Skip to content

Instantly share code, notes, and snippets.

@HoukasaurusRex

HoukasaurusRex/README.md

Last active December 23, 2020 10:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save HoukasaurusRex/1e3a9fddf21b84296dca2ba0b5bc5e7f to your computer and use it in GitHub Desktop.
Save HoukasaurusRex/1e3a9fddf21b84296dca2ba0b5bc5e7f to your computer and use it in GitHub Desktop.
Download ZIP
A Pretty Good Readme
Raw
README.md

Netlify Status Contributors HitCount Language grade: JavaScript FOSSA Status David Dependencies Status License: MIT LinkedIn Twitter: HoukasaurusRex


Logo

Houkasaurus README Template

A pretty good README to get started with
Explore the docs »

View Demo · Report Bug · Request Feature

About the Project

Houkasaurus Screen Shot

Why was this project started? Who is it for?

Built With

☕️ Getting Started

To get it running locally, install dependencies with yarn and run the commands

Prerequisites

  • yarn
npm install yarn@latest -g

Installation

# Install dependencies
yarn install

# Fetch content from CMS backend
yarn fetch:content

# Run local dev server
yarn dev

🔧 Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

🗺 Roadmap

See the open issues for a list of proposed features (and known issues)

🛠 Contributing

Want to make a change? Any contributions you make are greatly appreciated.

Check out the issues page

  1. Clone the repo
  2. Create your Feature Branch (gco -b release/my-project)
  3. Commit your Changes (git commit -m 'add: small addition')
  4. Push to the Branch (git push origin release/my-project)
  5. Open a Pull Request

✏️ Contact

✨ Acknowledgements

FOSSA Status

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment