mirror of
https://github.com/astuto/astuto.git
synced 2025-12-15 03:07:52 +01:00
d450fecda3693f167751771219b6902f68a8fa02
Bump rack from 2.0.7 to 2.0.8
Try the online demo!
What is Astuto?
Astuto is a free, open source, self-hosted customer feedback tool. It helps you collect, manage and prioritize feedback from your users. It has been heavely inspired by Canny.io ("astuto", indeed, is the italian translation of the word "canny"). If you are interested, you can check out a demo of Astuto.
Requirements
- Docker (installation instructions)
- Docker Compose (installation instructions)
Installation
- Ensure that you have the required software installed.
- Download Astuto by cloning this repo or from here.
- In the root directory, create a file named
.envand fill it with the required environment variables (see.env-examplefor an example and check this wiki page for an explanation of the variables). - Run
script/docker-update-and-run.sh. - You should now have a running instance of Astuto at
localhost:3000. A default user account has been created with credentials email:admin@example.com, password:password.
Post-installation notes
- If you run into any problems take a look at the common problems page.
- When you want to launch Astuto you have to run
script/docker-run.sh. If you installed new gems, packages or updated the database schema, you first need to runscript/docker-update.shand thenscript/docker-run.sh. You can run them together withscript/docker-update-and-run.sh. - You can always run
script/docker-update-and-run.shif unsure whether you should update or not. However, please note thatscript/docker-update-and-run.shtakes more time to run thanscript/docker-run.sh. - If you changed some environment variables in
.envyou have to restart the instance for these changes to take effect.
Contributing
Astuto is licensed under the GNU GPLv3 license. You are welcome to contribute:
- You can suggest new features from the Astuto demo.
- You can find a todo list of what we would like to work on next.
- You should take a look at the contribution guidelines.
- You should take a look at the technologies used to build Astuto. If you know at least one of them you are welcome to contribute to Astuto's codebase!
- You can run the test suite by typing
rspec. - If you just have some suggestions you can create an issue or email us directly.
Languages
TypeScript
48.4%
Ruby
42%
HTML
5.2%
SCSS
3.5%
Dockerfile
0.4%
Other
0.5%
