component-readme-template.md

About The Project

This section should contain a brief description of the project.

The following questions should be answered:

• An overview of what does the project do?

• How is this project useful for a developer? Feel free to include diagrams or link to external resources to provide context.

ENV CONFIGS

Any env variables that need to be configured should be place here

Getting Started

This section should include instruction on how a developer can setup the project and run it locally.

Below is an example of what this should look like.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct developers on installing and setting up your component.

1. Get a free API Key at https://example.com

2. Clone the repo

   git clone https://github.com/github_username/repo_name.git

3. Install NPM packages

   npm install

4. Enter your API key in .env file

   API_KEY = 'ENTER YOUR API';

5. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

(back to top)

Usage

Use this space to show useful examples of how a component can be used. Additional screenshots, code examples, and diagrams work well in this section.

(back to top)

RESOURCES

Any external resources that help provide context for a developer should be placed here