Claper

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

Report Bug · Request Feature

Table of Contents

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

About The Project

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.

Built With

Claper is proudly powered by Phoenix and Elixir.

• 
• 
• 

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
• Erland >= 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

All configuration used by the app is store on the .env file. You can find an example file in .env.sample, but you should copy it to .env and fill it with your own values.

Local

Variable	Values	Default	Required	Description
PRESENTATION_STORAGE	local, s3	local	-	Define where the presentation files will be stored
AWS_ACCESS_KEY_ID	-	-	only for s3	Your AWS Access Key ID
AWS_SECRET_ACCESS_KEY	-	-	only for s3	Your AWS Secret Access Key
AWS_S3_BUCKET	-	-	only for s3	The name of the bucket where the presentation files will be stored
AWS_S3_REGION	-	-	only for s3	The region where the bucket is located
MAIL_FROM	-	Claper	-	Email address used to send emails
MAIL_FROM_NAME	-	noreply@claper.co	-	Name used to send emails

Production / Docker

You can use all local variables plus the following:

Variable	Values	Default	Required	Description
DATABASE_URL	-	-	✓	Postgres connection string
SECRET_KEY_BASE	-	-	✓	Generate it with mix phx.gen.secret
SMTP_RELAY	-	-	✓	SMTP relay server
SMTP_USERNAME	-	-	✓	SMTP username
SMTP_PASSWORD	-	-	✓	SMTP password
SMTP_PORT	-	25	-	SMTP port
SMTP_TLS	always, never, if_available	always	-	SMTP TLS
SMTP_AUTH	always, never, if_available	always	-	SMTP Auth
SMTP_SSL	true, false	true	-	SMTP SSL

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

You can build the app with Docker:

docker build -t claper .
docker run -p 4000:4000 -d claper

Usage

Login/Signup

Claper is passwordless, so you don't have to create an account. Just login with your email, check your mailbox (localhost:4000/dev/mailbox if you have configured mail to be in local) and click on the link to get connected.

Roadmap

• Add Changelog
• Remove dead code
• Add additional tests for better coverage
• Add more docs

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

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

License

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

Contact

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