/Claper

The ultimate tool to interact with your audience

Primary LanguageElixirGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License


Logo

Claper

The ultimate tool to interact with your audience.
Explore the docs »

Report Bug · Request Feature

Product Name Screen Shot

Claper turns your presentations into an interactive, engaging and exciting experience.

Claper has a two-sided mission:

  • The first one is to help these people presenting an idea or a message by giving them the opportunity to make their presentation unique and to have real-time feedback from their audience.
  • The second one is to help each participant to take their place, to be an actor in the presentation, in the meeting and to feel important and useful.

Supported languages: 🇬🇧 English, 🇫🇷 French, 🇩🇪 German.

Built With

Claper is proudly powered by Phoenix and Elixir.

  • Phoenix
  • Elixir
  • Tailwind

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To run Claper on your local environment you need to have:

  • Postgres >= 9
  • Elixir >= 1.13.2
  • Erlang >= 24
  • NPM >= 6.14.17
  • NodeJS >= 14.19.2
  • Ghostscript >= 9.5.0 (for PDF support)
  • Libreoffice >= 6.4 (for PPT/PPTX support)

You can also use Docker to easily run a Postgres instance:

  docker run -p 5432:5432 -e POSTGRES_PASSWORD=claper -e POSTGRES_USER=claper -e POSTGRES_DB=claper --name claper-db -d postgres:9

Configuration

You can find all configuration options in the docs.

Installation

  1. Clone the repo
    git clone https://github.com/ClaperCo/Claper.git
  2. Install dependencies
    mix deps.get
  3. Migrate your database
    mix ecto.migrate
  4. Install JS dependencies
    cd assets && npm i
  5. Allow execution of startup file
    chmod +x ./start.sh
  6. Start Phoenix endpoint with
    ./start.sh

Now you can visit localhost:4000 from your browser.

If you have configured MAIL to local, you can access to the mailbox at localhost:4000/dev/mailbox.

Using Docker Compose

A Docker Compose reference file is provided in the repository. You can use it to run Claper with Docker Compose.

git clone https://github.com/ClaperCo/Claper.git
cd Claper
docker-compose up

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/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 GPLv3 License. See LICENSE.txt for more information.

Contact

Project Link: https://github.com/ClaperCo/Claper