Skip to content

Latest commit

 

History

History
125 lines (85 loc) · 3.1 KB

README-template.md

File metadata and controls

125 lines (85 loc) · 3.1 KB
Raw

🎲 Project Name

Short description of the project.

code size repository size commits last commit is website up?

📑 Table of Contents

📄 Description

Full description of the project:

  • What is it about?
  • What does it do?
  • Why is it useful?
  • What problem does it solve?
  • Who is it for?

🚀 Getting Started

Prerequisites

  • You need this item
  • And you need this item
  • Oh, and don't forget this item

Installation

⚙ Usage

Instructions for how to configure, run, and use the project. You can include the commands needed to install and start the development environment or any other useful and important commands. Screenshots can be included as well.

Look for more information in the [Documentation].

🧪 Testing

  • Any unit or integration tests people can run to assure that everything’s working as expected?
  • Any frameworks or commands that are needed here?
  • Are there any tests in your deployment pipeline that ensure that no errors make it into the live site?

Also include the commands needed to run any tests:

# Run test(s)
npm run test

Deployment

Instructions for how to deploy the project to a production environment, including any server requirements and commands used. And, in case you are using a CI/CD pipeline, for example, how do any automated processes work? What are the most important branches? Do they trigger any pipelines?

GitHub Pages - Vercel - Netlify - Cloudflare Pages

Useful Commands

# Install dependencies
npm install

# Update dependencies
npm update

# Start local dev server
npm start

# Check formatting w/ Prettier
npm run check

# Fix formatting w/ Prettier
npm run format

For more details take a look at package.json.

🔌 Plugins

  • Plugin 1
  • Plugin 2

Changelog

We use Semantic Versioning for releases.

  • 0.1.0
    • First release
    • CHANGE: Rename foo() to bar()
    • FIX: Crash when calling pleasedonotcrash()
  • 0.0.1
    • Initial commit

🗺 Roadmap

  • Completed Change 1
  • Completed Change 2
  • Incomplete Roadmap Item 1
  • Incomplete Roadmap Item 2

❤ Acknowledgments

Thanks to these amazing people and their projects:

  • [Person] – [Website]
  • [Project] - [Website]

© License

This code is available under the MIT License.