This application requires the node version 10.16 LTS to run.
Newer node versions are untested but may still work.
- Install dependencies with
yarn - Start backend with
yarn server - Start frontend with
yarn start - Visit localhost:3000
Run rests with yarn test
Run production build with yarn build
- User can login and view a list of channels
- User can join a channel and see list of users in the channel
- User can send a message to the channel
- User can reply to a message
- User can see when other users are typing
- Developers should be able to create bot integrations quickly and easily
- Users should be serenaded by quotes from the Zen of Python
- Users can see suppressed messages
- Browser client can detect and suppress toxic messages
- Mischievious bots should blurt out toxic messages (lol)
- Users can read and unread messages
- Add e2e smoke tests with cypress for "critical" user flows
- User should be able to add and remove channels
- Responsive experience for mobile devices
- User should be able to react to messages
- Build and deploy with electron
- Fully support offline mode
- Optimize lighthouse score
- Github security alerts
- Keyboard shortcuts
- Emoji support
- Devices should sync critical data within 2 seconds
- Microapp should be interactive within 1 second
- Is it easy to build and test locally?
- Is it easy to enable and disable feature toggles?
- Is it easy to configure local development environment to proxy to qa and production environments?
- Are pull requests passing tests before merged into master?
- Do e2e tests for critical user flows protect deployments to production?
- Is it fast create and deploy new microapp versions to production?
- Is it simple to rollback to the last known stable version?
- Are service-level objectives measured and enforced?
- Are translations completed and versioned with the app?
- Are clients resilient to brief (<5 minute) platform outages?
- Is PII data handled securely and responsibly?
- Are readmes and runbooks up-to-date?
- Do "warnings" get logged when something unexpected happens?
- Are "warnings" alerts captured and easy to review asynch?
- Do "critical" alerts fire when users are impacted?
- Are the right people alerted when users are "critically" impacted?
- Are "critical" alerts clearly actionable?
- Are important user metrics captured easy to understand at a glance?
- Is it simple to see the overall health of the platform?
- Is it easy to determine the root cause of an incident?
- Is it easy to describe user impact during an incident?
- Does the platform self-heal when something unexpected happens?
- Does the platform honor GDPR requirements?
- Speed
- Simplicity
- Maintainability
- Showcase modern tech
- Have some fun :)
- Zen of Python
- create-react-app
- @tensorflow-models/toxicity
- The core ideas behind Distributed Object Protocol
- Cypress
DECISION
This microapp will use hard-coded english strings to unlock development velocity.
TRADE OFF
Translations can easily be retrofitted later.
DECISION
This microapp is built with React to unlock development velocity.
TRADE OFF
Short term, mobile users can still open the app in their mobile browser. A responsive version of the app will be displayed to improve the user experience.
Long term, newer technologies like flutter and ReactNative should be considered to make it easier for smaller teams to maintain cross-platform experiences now and in the future.
Additional research is necessary before further consideration.
-
It may be nice to define the redux store once, and share code between client and server. This would simplify the system and make it easier to reason about.
-
Consider using the same event names across the frontend and backend.