Houkasaurus README Template

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

View Demo · Report Bug · Request Feature

About the Project

Why was this project started? Who is it for?

Built With

• React
• Vue
• Express

☕️ 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

• JT Houk - @HoukasaurusRex

✨ Acknowledgements

• Best README Template
• Pretty Good README
• GitHub Emoji Cheat Sheet
• Img Shields