mirror of
https://github.com/astuto/astuto.git
synced 2025-12-14 18:57:51 +01:00
9176b96167501762d9697c2e634da04bb58eb310
- Remove links to demo and docs website from README
- Remove most links across the codebase referring to docs.astuto.io and astuto.io
Goodbye, Astuto 🥲
Astuto is an open source customer feedback tool. It helps you collect, manage and prioritize feedback from your customers, so you can build a better product.
Features
- Roadmap: show users what you're working on
- Simple Sign In: let users log in with email or any OAuth2 provider
- Webhooks: integrate with your existing tools (e.g. Jira, Trello, Slack)
- API: programmatically manage your feedback space with our REST API
- Moderation Queue: decide whether to show new feedback immediately or request approval
- Anonymous Feedback: enable unregistered users to publish feedback
- ... and more: invitation system, brand customization, recap emails for administrators, private site settings, and more!
Documentation
Documentation website is not online anymore. You can read Astuto's documentation from the GitHub repository.
Get started
- Ensure you have Docker and Docker Compose installed
- Create an empty folder
- Inside that folder, create a
docker-compose.ymlfile with the following content:
services:
db:
image: postgres:14.5
environment: &db-env
POSTGRES_USER: yourpostgresusername
POSTGRES_PASSWORD: yourpostgrespassword
volumes:
- dbdata:/var/lib/postgresql/data
web:
image: riggraz/astuto:latest
environment:
<<: *db-env
BASE_URL: http://yourwebsite.com
SECRET_KEY_BASE: yoursecretkeybase
ports:
- "3000:3000"
depends_on:
- db
volumes:
dbdata:
- Edit the environment variables to fit your needs
- Run
docker compose pull && docker compose up - You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email:
admin@example.com, password:password.
Contributing
There are many ways to contribute to Astuto, not just coding. Proposing features, reporting issues, translating to a new language or improving documentation are a few examples! Please read our contributing guidelines to learn more.
Credits
Astuto logo and all image assets are credited here.
A huge thank you to code contributors
Languages
TypeScript
48.4%
Ruby
42%
HTML
5.2%
SCSS
3.5%
Dockerfile
0.4%
Other
0.5%
