README.md

Tell Me

---

An awesome open source survey generator!

---

⚠️ Warning
Work and documentation in progress. The v1 is coming soon!

• Roadmap
• Deployment
  • Heroku
  • Scalingo
• Contributing
  • Developers
  • Translators

---

Roadmap

• 🪅 Accessibility
• 🔼 Survey file upload field
• 🔑 Public API via PAT generation
• 🗳️ Submissions deletion
• 📊 Dashboard statistics
• 🐾 Teams
• 🌎 Localisation CI via Crowdin

Deployment

⚠️ IMPORTANT
You can't deploy and run successful instances without generating and setting EDDSA_PRIVATE_KEY and NEXT_PUBLIC_EDDSA_PUBLIC_KEY env vars.
This will be only handled once the setup feature is ready.

Tell Me application is automatically deployable on most PaaS. It's also relatively easy to deploy via Docker.

You'll only need to attach a PostgreSQL database.

Heroku

Scalingo

Contributing

Developers

Please check our CONTRIBUTING.md document to setup and run Tell Me locally 🛸.

Translators

Please join our Crowdin Dashboard to help us translate Tell Me to the world 🌎!