0.0.6 • Published 3 years ago

@civilstonks/civilstonks-components v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

civilstonks-components

Made with create-react-library

NPM JavaScript Style Guide

Environment Variables

  • REACT_APP_CIVILSTONKS_API (required) - URL for the civil stonks API (must have a trailing slash)
    • E.g. https://api.civilstonks.com/

Events Data

  • uuid required unique identifier
  • type required crypto|stock
  • ticker required ticker identifier (crypto or stock 3/4 digit identifer)
  • title required
  • twitter_id optional
  • description optional

Example

{
 "uuid": "1984407c-5523-448a-a718-754c869d3782",
 "type": "crypto",
 "ticker": "DOGE",
 "title": "Elon Doge Coin",
 "twitter_id": "1391523807148527620",
 "description": "Elon Musk tweets about Doge Coin spiking the price"
}

Development Notes

Create React Library doesn't support JSX fragments as <>...</>, you have to explicitly type <Fragment>...</Fragment> (Github Issue).

License

MIT © civilstonks