mirror of
https://github.com/astuto/astuto.git
synced 2025-12-15 19:27:52 +01:00
dc9f4f1b26d16a981667bd5f8d8b6b0ceff05b21
Astuto
Astuto is a free, open source, self-hosted customer feedback tool. It has been heavely inspired by Canny.io ("astuto", indeed, is the italian translation of the word "canny"). You can check out a demo here.
Requirements
Installation
- Ensure that you have the required software installed.
- Download Astuto from here or by cloning this repo.
- In the root directory, create a file named
.envand write the required environment variables (see file.env-examplefor an example and check this page for an explanation of the variables). - Run
script/docker-update-and-run.sh. - You should now have a running instance of Astuto, check it out at
localhost:3000. A default user account has been created with credentials email:admin@example.com, password:password.
Post-installation notes
- 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
You are welcome to contribute:
- Here you can find a todo list of what we would like to work on next.
- Here you can take a look at the contributing guidelines.
- Here you can take a look at the technologies used to build Astuto. Don't wory, you do not need to know each of them!
- 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%