Open Response

A powerful tool for collecting and analyzing product feedback from your users!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Open Response is a comprehensive feedback collection tool designed to help product teams gather, analyze, and act on user feedback. Whether you're launching a new feature or improving an existing product, Open Response provides the insights you need to make data-driven decisions.

Here's why Open Response stands out:

• Real-time Feedback Collection: Capture user responses instantly through customizable forms and surveys
• Advanced Analytics: Gain actionable insights with powerful data visualization and sentiment analysis
• Easy Integration: Seamlessly integrate with your existing product workflow and tools
• User-Friendly Interface: Both administrators and respondents enjoy a clean, intuitive experience

Open Response eliminates the complexity of traditional feedback systems while providing enterprise-level features for teams of all sizes.

(back to top)

Built With

Open Response is built using modern, reliable technologies to ensure performance and scalability:

• 
• 
• 

(back to top)

Getting Started

Getting Open Response up and running is straightforward. Follow these steps to set up the feedback collection system for your product.

Prerequisites

Before installing Open Response, ensure you have the following:

For the Backend:

• Python (v3.9 or higher)
• uv package manager

  curl -LsSf https://astral.sh/uv/install.sh | sh

• PostgreSQL database

For the Frontend:

• Node.js (v16 or higher)

  npm install npm@latest -g

Installation

Follow these steps to install and configure Open Response:

Backend Setup (Django + DRF)

Note: For a more detailed setup guide, see backend.md

1. Clone the repository

   git clone https://github.com/okotdaniel/open-response.git

2. Navigate to the backend directory

   cd open-response/backend

3. Create and activate virtual environment with uv

   uv venv
   source .venv/bin/activate  # On macOS/Linux

4. Install Python dependencies

   uv pip install -r requirements.txt

5. Set up your environment variables in .env

   DATABASE_URL=postgresql://username:password@localhost:5432/openresponse
   SECRET_KEY=your_secret_key
   DEBUG=True
   ALLOWED_HOSTS=localhost,127.0.0.1

6. Run database migrations

   python manage.py migrate

7. Create a superuser (optional)

   python manage.py createsuperuser

8. Start the Django development server

   python manage.py runserver

Frontend Setup (Next.js)

Note: For a more detailed setup guide, see frontend.md

1. Navigate to the frontend directory

   cd open-response/frontend

2. Install Node.js dependencies

   npm install

3. Set up your environment variables in .env.local

   NEXT_PUBLIC_API_URL=http://localhost:8000/api
   NEXT_PUBLIC_SITE_URL=http://localhost:3000

4. Start the Next.js development server

   npm run dev

Accessing the Application

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000/api
• Django Admin: http://localhost:8000/admin

(back to top)

(back to top)

Usage

Open Response can be used in various scenarios to collect valuable product feedback:

Creating Feedback Forms: Design custom forms tailored to your specific feedback needs Embedding Surveys: Integrate feedback widgets directly into your product interface
Analyzing Responses: Use built-in analytics to identify trends and insights Managing Feedback Campaigns: Organize and track multiple feedback initiatives

For detailed examples and API documentation, please refer to the Documentation

(back to top)

Roadmap

• Core feedback collection system
• Basic analytics dashboard
• Email notifications
• Advanced sentiment analysis
• Integration with popular project management tools
• Mobile app for feedback management
• Multi-language Support
  • Spanish
  • French
  • German
• AI-powered feedback categorization
• Advanced reporting and export features

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

Daniel Okot - @okotdaniel - daniel@openresponse.com

Project Link: https://github.com/okotdaniel/open-response

(back to top)

Acknowledgments

We'd like to thank the following resources and communities that made Open Response possible:

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)