Brainstormer

Your ultimate tool for capturing and organizing your brilliant ideas collaboratively!

Brainstormer is a web application built using Vue.js for the frontend and Flask for the backend. It allows teams to create brainstorming sessions, add ideas to these sessions, vote on ideas, and manage sessions and ideas efficiently in a collaborative environment.

Table of Contents

• Features
• Tech Stack
• Project Structure
• Setup and Installation
• Usage
• Contributing
• License
• Contact

Features

• Create Brainstorming Sessions: Easily create new sessions for different brainstorming activities.
• Add Ideas: Quickly add ideas to any session.
• Vote on Ideas: Vote for the ideas you like the most.
• Delete Sessions and Ideas: Manage your sessions by deleting them or their ideas when they are no longer needed.
• Collaborative Environment: Work together with your team in real-time to brainstorm and refine ideas.

Tech Stack

• Frontend:

  • Vue.js
  • Axios
  • Bootstrap

• Backend:

  • Flask
  • Flask-CORS
  • PostgreSQL

Project Structure

├── babel.config.js
├── backend
│   └── app.py
├── jsconfig.json
├── package.json
├── package-lock.json
├── public
│   ├── favicon.ico
│   └── index.html
├── README.md
├── src
│   ├── App.vue
│   ├── assets
│   │   └── brainstormer_logo.png
│   ├── components
│   │   ├── IdeaForm.vue
│   │   ├── IdeaItem.vue
│   │   ├── IdeaList.vue
│   │   ├── SessionItem.vue
│   │   └── SessionList.vue
│   └── main.js
└── vue.config.js

Setup and Installation

Prerequisites

• Node.js
• Python
• Flask

Environment Variables

Create a .env file in the root directory and add the following environment variables:

VUE_APP_API_BASE_URL=http://localhost:5000
DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase

Replace username, password, localhost, 5432, and mydatabase with your PostgreSQL database credentials.

Frontend Setup

1. Clone the repository:

   git clone https://github.com/abeltavares/brainstormer.git

2. Install dependencies:

   npm install

3. Start the frontend development server:

npm run serve

Backend Setup

1. Navigate to the backend directory:

   cd backend

2. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate

3. Install dependencies:

   pip install -r requirements.txt

4. Set up the database:

   flask db upgrade

5. Run the Flask server:

   flask run

Usage

1. Open your browser and navigate to http://localhost:8080 to access the Brainstormer app.
2. Create a new brainstorming session by entering a session title and clicking "Add Session".
3. Share the session link with your team members, so they can join and contribute in real-time.
4. Add ideas to the session, vote on ideas, and manage the sessions and ideas using the available options.
5. Collaborate with your team to refine and prioritize ideas effectively.

Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the branch: git push origin feature-name.
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy Brainstorming! 💡

---

Go to Top