mxchinegod / digits-api-altdata

digits-api-altdata is the Digits service responsible for retrieving alternative data, which is sort of a catchall for "not scientifically evaluated" in the investing world.

digits-api-altdata is the Digits service responsible for retrieving alternative data, which is sort of a catchall for "not scientifically evaluated" in the investing world.

---

📝 Code Properties ✨

The stack below is minimal as what we do in this API is mostly bridge external HTTP requests and preprocess data.

📁 Library	⚙ Purpose	📎 Version
NodeJS	Base	16.18.0
express	Session Middleware	4.18.2

You will want to know about each of these in depth by the above order.

🎬 Environment ✨

config.js should be created from config.example.js

• newsApi is the key which News API uses to make authenticated requests.
• servicePort is this service's port. If you change it, you will need to change your config.js in digits-api-main

npm i

📜 Provided Scripts ✨

Digits AI provides some useful scripts to help you quick start.

Scripts provided in package.json. It's safe to modify or add additional scripts, but here are the defaults:

💡 start

npm start

🏰 Service Mesh API ✨

digits-api-altdata is responsible creative problem solving when it comes to data acquisition i.e. if something is scraped and not scheduled, it's probably here.

• 🔌 Interfacing [ http ]
  • All API routing is done through http requests. It's possible sockets play a role one day.
• 🩺 Monitoring [ http ]
  • This API intrinsically reports to digits-api-main
• 🧮 Preprocessing [ node ]
  • All data is preprocessed, all data is alternative in nature thus has a lot of work done on it before serving to the API where even more may be done, and then to the UI. This is a reason to consolidate where preprocessing occurs as much as possible.

💎 Goals ✨

immediate

• Initialize beautiful README.md
• Describe service API role
• Add husky pre-commit
• Create mesh diagram
• Explain preprocessor philosophy
• Add politician investing history
• Add Twitter feeds from select followed list

long-term

• Docker images
• Kubernetes deployment

🙋 Contribution

Proper commit message format is required for automated changelog generation. Examples:

[<emoji>] [revert: ?]<type>[(scope)?]: <message>

💥 feat(compiler): add 'comments' option
🐛 fix(compiler): fix some bug
📝 docs(compiler): add some docs
🌷 UI(compiler): better styles
🏰 chore(compiler): Made some changes to the scaffolding
🌐 locale(compiler): Made a small contribution to internationalization

Other commit types: refactor, perf, workflow, build, CI, typos, tests, types, wip, release, dep