/chator

Ch@or: A little chat application

Primary LanguageJavaScript

Ch@or: A little chat application

Functionality:

  • stores 50 messages
  • first-in first-out (FIFO)
  • first version in memory (no DB)

API:

  • list the last up-to-50 messages
  • submit a message
  • a message is a string of up-to 281 characters
  • see below

Management:

  • this is managed in git
  • source code hosted on GitHub (OBVS)

Deployment

  • Google Cloud virtual machine with MariaDB
  • initdb.sql creates the necessary database structure
    • for those using pre-2019-02-01 versions, please use this to upgrade your DB: npm run updatedb-2019-02-01
  • set up server/config.json using the sample in server/config-sample.json with your credentials

API and Documentation

  • /messages
    • GET: retrieve the last 50 messages
    • POST: add a message

See more documentation in docs/

  • docs/architecture.md – an overview of the software design of Ch@or
  • docs/api.md and docs/api-v1.md – definition of the API
  • docs/setup.md how to set up Ch@or for running and development

Contributing

We welcome ideas and contributions of code.

  • If you have ideas for features or enhancements, please:
    • do open an issue
    • do use descriptive well-formed English language sentences to describe your idea rather than short bursts of words.
    • do spell and grammar check your submission - help us avoid any unnecessary confusion.
    • don't be offended if we can't use your idea immediately.