Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 2.35 KB

README.md

File metadata and controls

101 lines (68 loc) · 2.35 KB
Raw

IdeaBox

Welcome to IdeaBox, an open-source customer feedback and roadmap management tool.

Screenshot

This application is designed to help businesses gather, organize, and prioritize customer feedback to streamline their product development and roadmap planning. Built with Laravel, Inertia, React, and Tailwind, IdeaBox offers a robust and user-friendly platform for managing customer insights.

Features

  • Feedback Collection: Easy-to-use interface for collecting customer feedback.
  • Roadmap Management: Visualize and plan your product roadmap based on customer insights.
  • Prioritization Tools: Prioritize feedback to focus on what matters most to your customers.

Getting Started

Prerequisites

Ensure you have the following installed:

  • PHP
  • Composer
  • Node.js
  • Yarn

Installation

  1. Clone the Repository

    git clone https://github.com/your-username/IdeaBox.git
cd IdeaBox

  2. Install PHP Dependencies

    composer install

  3. Set Up Environment Variables

    • Copy .env.example to .env and configure your environment variables.
    • Generate an application key. 
      php artisan key:generate
      To set the application logo, add a square image as logo in the environment:
    APP_LOGO='https://path/to/logo.svg'

  4. Run Database Migrations

    php artisan migrate
php artisan db:seed

    A user has been created with the following credentials:

     Email: admin@example.com
 Password: password

  5. Install JavaScript Dependencies

    yarn

  6. Build Assets

    yarn build

Usage

Start the local development server:

php artisan serve

Navigate to http://localhost:8000 in your web browser to view the application.

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.

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

License

Distributed under the MIT License. See LICENSE for more information.