npm install forkast-labs-componentsimport React from "react";
import ReactDOM from "react-dom";
import { Index, ThemeProvider } from "forkast-labs-package";
const App = () => {
return (
<ThemeProvider
colors={{
background: "#171717",
text: "#FFFFFF",
}}
>
<Index symbol={indexName} />
</ThemeProvider>
);
};
ReactDOM.render(<App />, document.getElementById("root"));ThemeProvider
| Props | Type | Description |
|---|---|---|
| colors.headline | string | brand color |
| colors.background | string | basic background color for elements |
| colors.text | string | text color |
Index
| Props | Type | Description |
|---|---|---|
| symbol | fk500, fketh, fksol |
symbol name |
IndexDetailed
| Props | Type | Description |
|---|---|---|
| symbol | fk500, fketh, fksol |
symbol name |
To use the React component, you need to sign up for the free Forkast Labs API service. This service delivers high-performance access to the Forkast Labs indexes with up to 250,000 API calls per month.
It couldn't be simpler: Go to our developer web site and create your Free developer account. Pass your URL prefix and API keys from your account to the component in your environment, and you're off and running.
The following environment variables need to be set in order to use this package:
- WEB_API_URL: the URL for the Forkast Labs API service.
- API_KEY: the API key for the Forkast Labs API service.
- WP_API_URL: the WordPress API url.
- WP_INDEX_TAGS: Tags map between index and WordPress tag ids.
If you see an error message or run into an issue, please create bug report.
If you have an idea, or you're missing a capability that would make development easier and more robust, please Submit feature request.
If a similar feature request already exists, don't forget to leave a "+1". If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly :)