Karrot Documentation

This is the very early stage of some product/developer documentation for Karrot.

Purposes would/could be to document:

• useful resources/links
• dev FAQs
• feature descriptions
• high level code design concepts
• our conventions (e.g. enriching vuex getters)

Contents

• FAQ
• Features
  • Groups
  • Applications
  • Places
  • Activities
  • Issues
  • Offers
  • Trust
  • Account
  • General
• Frontend structure
  • State
  • Forms
  • Pages and Routes
  • Alerts
  • I18n
• Self hosting
• Backend introduction
• Notifications
• Sparkpost

Useful links

• Code
  • frontend karrot-dev/karrot-frontend
  • backend karrot-dev/karrot-backend
• Issues
  • product and frontend - karrot-dev/karrot-frontend/issues
  • backend - karrot-dev/karrot-frontend/issues
• Other documentation
  • user docs (coming soon)
  • API docs dev.karrot.world/docs/ (create account and login to see more
• Chat
  • chat.karrot.world/channel/karrot-dev
• Deployments
  • dev dev.karrot.world - master branch using dev backend/db
  • production karrot.world - production backend/db