Giter Club home page Giter Club logo

b310-digital / mindwendel-website Goto Github PK

View Code? Open in Web Editor NEW

This project forked from b310-digital/mindwendel

0.0 0.0 0.0 9.72 MB

Create a challenge. Ready? Brainstorm. mindwendel helps you to easily brainstorm and upvote ideas and thoughts within your team.

Home Page: https://www.mindwendel.com

License: GNU Affero General Public License v3.0

Shell 0.25% JavaScript 2.08% Elixir 76.90% HTML 10.87% PLpgSQL 7.16% Dockerfile 1.36% SCSS 1.36% Procfile 0.02%

mindwendel-website's Introduction

mindwendel

Workflow Status Badge

Create a challenge. Ready? Brainstorm. mindwendel helps you to easily brainstorm and upvote ideas and thoughts within your team. Built from scratch with Phoenix.

Features

  • 5 minute setup (It is not a joke)
  • Anonymously invite people to your brainstormings - no registration needed. Usernames are optional.
  • Easily create and upvote ideas, with live updates from your companions.
  • Cluster your ideas with custom labels
  • Preview of links to ease URL sharing
  • Export your generated ideas to html or csv (currently comma separated)
  • German & English Translation files
  • By default, brainstormings are deleted after 30 days to ensure GDPR compliancy.

Use-cases

Brainstorm ...

  • ... new business ideas
  • ... solutions for a problem
  • ... what to eat tonight
  • ...

Getting Started

mindwendel can be run just about anywhere. So checkout our Installation Guides for detailed instructions for various deployments.

Here's the TLDR:

  • Run mindwendel via Docker and reference your postgres database

    docker run -d --name mindwendel \
      -p 127.0.0.1:80:4000 \
      -e DATABASE_HOST="..." \
      -e DATABASE_PORT="5432" \
      -e DATABASE_SSL="false" \
      -e DATABASE_NAME="mindwendel_prod" \
      -e DATABASE_USER="mindwendel_db_user" \
      -e DATABASE_USER_PASSWORD="mindwendel_db_user_password" \
      -e SECRET_KEY_BASE="generate_your_own_secret_key_base_and_save_it" \
      -e URL_HOST="your_domain_to_mindwendel" \
      ghcr.io/mindwendel/mindwendel

NOTE: mindwendel requires a postgres database. You can use our docker-compose file to also install the postgres.

Contributing

To get started with a development installation of mindwendel, follow the instructions below.

mindwendel is built on top of:

Development

  • Startup docker-compose setup

    docker-compose up --build -d
  • Setup the database

    docker-compose exec app mix ecto.setup
  • Start the server

  docker-compose exec app mix phx.server

Testing

  • Startup docker-compose setup

    docker-compose up --build -d
  • Ensure your database is running and reset your database

    docker-compose exec app mix ecto.test.prepare
  • Run the test

    docker-compose exec app mix test

Production

  • Generate self-signed ssl sertificate for the postgres server on the host machine; the generated files are mounted into the docker container

    mkdir -p ./ca
    openssl req -new -text -passout pass:abcd -subj /CN=localhost -out ./ca/server.req -keyout ./ca/privkey.pem
    openssl rsa -in ./ca/privkey.pem -passin pass:abcd -out ./ca/server.key
    openssl req -x509 -in ./ca/server.req -text -key ./ca/server.key -out ./ca/server.crt
    chmod 600 ./ca/server.key
    test $(uname -s) = Linux && chown 70 ./ca/server.key
  • Duplicate and rename .env.default

    cp .env.prod.default .env.prod
  • Adjust all configs in .env.prod, e.g. database settings, ports, disable ssl env vars if necessary

  • Start everything at once (including a forced build):

    docker-compose --file docker-compose-prod.yml --env-file .env.prod up -d --build --force-recreate
  • Open the browser and go to http://${URL_HOST}

Note

  • The url has to match the env var URL_HOST; so http://localhost will not work when your URL_HOST=0.0.0.0
  • The mindwendel production configuration is setup to enforce ssl, see Mindwendel.Endpoint configuration in config/prod.exs
  • The mindwendel production configuration supports deployment behind a reverse porxy (load balancer) by parsing the proper protocol from the x-forwarded-* header of incoming requests, see config/prod.exs

Build release and production docker image

  • Build the docker image based on our Dockerfile
    docker build -t mindwendel_prod .

Formatting

We are using Elixir's built-in formatter.

  • Check if the code is properly formatted
    mix format --check-formatted
  • Automatically format the code
    mix format

Environment Variables

Localization

Currently, there are two language files available, german ("de") and english ("en"). To set the default_locale, you can set MW_DEFAULT_LOCALE. The default is english.

You can extract new strings to translate by running:

mix gettext.extract --merge

Contributing

  1. Fork it (https://github.com/mindwendel/mindwendel/fork)
  2. Create your feature branch (git checkout -b fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin fooBar)
  5. Create a new Pull Request

Testimonials

kits is a project platform hosted by a public institution for quality development in schools (Lower Saxony, Germany) and focusses on digital tools and media in language teaching. mindwendel is used in workshops to activate prior knowledge, and collect and structure ideas. In addition, mindwendel can be found on https://kits.blog/tools and can be used by schools for free. More info on how to use it can be found in this post https://kits.blog/digitale-lesestrategien-brainstorming/

Logos and text provided with courtesy of kits.

Acknowledgements

mindwendel-website's People

Contributors

gerardo-navarro avatar jannikstreek avatar nwittstruck avatar tim-krieger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.