mirror of
https://github.com/astuto/astuto.git
synced 2025-12-15 19:27:52 +01:00
Update README and CONTRIBUTING (#124)
This commit is contained in:
Riccardo Graziosi
committed by
GitHub
GitHub
parent
e2065b2c5e
commit
07ca2a304a
59
README.md
59
README.md
@@ -6,38 +6,21 @@
|
||||
<a href="https://www.producthunt.com/posts/astuto?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-astuto" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=179870&theme=dark&period=daily" alt="Astuto - An open source customer feedback tool 🦊 | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a>
|
||||
</p>
|
||||
|
||||
<h2 align="center"><a href="http://65.21.148.99:3000/">🦊 Try the demo out 🦊</a></h2>
|
||||
|
||||
---
|
||||
|
||||
- [What is Astuto?](#what-is-astuto)
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Post-installation notes](#post-installation-notes)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
---
|
||||
<h3 align="center"><a href="http://65.21.148.99:3000/">Try the demo out</a></h3>
|
||||
<h5 align="center">To login as administrator:<br />email: admin@example.com | pass: password</h5>
|
||||
|
||||
## 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](https://canny.io/) ("astuto", indeed, is the italian translation of the word "canny"). If you want to try Astuto out there is a temporary demo <a href="http://65.21.148.99:3000/">available here</a>.
|
||||
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](https://canny.io/) ("astuto", indeed, is the italian translation of the word "canny").
|
||||
|
||||
<img src="./images/featured-image.png" />
|
||||
|
||||
## Features
|
||||
|
||||
* Collect and manage feedback
|
||||
* Boards, to divide different types of feedback
|
||||
* Roadmap, to let your users know what you're working on
|
||||
* Comments, to discuss with your customers
|
||||
* Notifications, to inform post owner of comments
|
||||
* Feedback labels, to inform about the state of a certain feedback
|
||||
* Feedback updates, to notify your users with news regarding a certain feedback
|
||||
* Completely customizable (i.e. you can add/edit/remove as many boards, feedback statuses as you want; you can configure the roadmap the way you want; etc.)
|
||||
* Admin panel (multiple admins/moderators allowed)
|
||||
* Dark mode
|
||||
* Create custom boards and statuses, to better organize feedback
|
||||
* Customize your roadmap, to let your users know what you're working on
|
||||
* Many more...
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -48,23 +31,31 @@ It has been heavely inspired by [Canny.io](https://canny.io/) ("astuto", indeed,
|
||||
|
||||
**Note**: it is strongly suggested to run Astuto on Linux or macOS. As of today, Windows is likely to [cause problems](https://github.com/riggraz/astuto/wiki/Common-problems#standard_init_linuxgo211-exec-user-process-caused-no-such-file-or-directory). If you want to try anyway, follow along with the [Windows users installation guide](https://github.com/riggraz/astuto/wiki/Installation-for-Windows-users).
|
||||
|
||||
1. Ensure that you have the required software installed.
|
||||
2. Clone this repository.
|
||||
3. In Astuto's root directory, create a file named `.env` and fill it with the required environment variables (see `.env-example` for an example and check [this wiki page](https://github.com/riggraz/astuto/wiki/Required-environment-variables) for an explanation of the variables).
|
||||
4. Run `script/docker-update-and-run.sh`.
|
||||
5. 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`.
|
||||
### Manual (for development)
|
||||
|
||||
1. Clone this repository.
|
||||
2. In Astuto's root directory, create a file named `.env` and fill it with the required environment variables (see `.env-example` for an example and check [this wiki page](https://github.com/riggraz/astuto/wiki/Required-environment-variables) for an explanation of the variables).
|
||||
3. Run `script/docker-update-and-run.sh`.
|
||||
4. 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`.
|
||||
|
||||
### Using DockerHub image (fastest)
|
||||
|
||||
Coming soon!
|
||||
|
||||
## Post-installation notes
|
||||
|
||||
* **If you run into any problems take a look at the [common problems page](https://github.com/riggraz/astuto/wiki/Common-problems)**.
|
||||
* 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 run `script/docker-update.sh` and then `script/docker-run.sh`. You can run them together with `script/docker-update-and-run.sh`.
|
||||
* You can always run `script/docker-update-and-run.sh` if unsure whether you should update or not. However, please note that `script/docker-update-and-run.sh` takes more time to run than `script/docker-run.sh`.
|
||||
* If you changed some environment variables in `.env` you have to restart the instance for these changes to take effect.
|
||||
|
||||
## Contributing
|
||||
|
||||
Astuto is licensed under the [GNU GPLv3](https://github.com/riggraz/astuto/blob/master/LICENSE) license. You are welcome to contribute:
|
||||
* Join the [Discord channel](https://discord.gg/SrtUMRp) to get in touch.
|
||||
* You should take a look at the [technologies](https://github.com/riggraz/astuto/wiki/Technologies) used to build Astuto.
|
||||
* You can run the test suite by typing `rspec` inside the `web` container. Before you can run `rspec`, you need to uncomment the Google Chrome installation lines in `docker/app/Dockerfile` and run `./script/docker-update-and-run.sh`.
|
||||
* If you just have some suggestions you can [create an issue](https://github.com/riggraz/astuto/issues), [email us directly](mailto:riccardo.graziosi97@gmail.com) or [text us in our Discord server](https://discord.gg/SrtUMRp).
|
||||
You are welcome to contribute:
|
||||
* Read our [contributing guidelines](https://github.com/riggraz/astuto/blob/main/CONTRIBUTING.md)
|
||||
* Join the [Discord channel](https://discord.gg/SrtUMRp) to get in touch
|
||||
|
||||
A huge thank you to all people who contributed:
|
||||
|
||||
<a href="https://github.com/riggraz/astuto/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=riggraz/astuto" />
|
||||
</a>
|
||||
|
||||
Reference in New Issue
Block a user