[![Product Name Screen Shot][product-screenshot]](https://claper.co)
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.
* [![Phoenix][Phoenix]][Phoenix-url]
* [![Elixir][Elixir]][Elixir-url]
* [![Tailwind][Tailwind]][Tailwind-url]
<!-- GETTING STARTED -->
## 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:
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.
- **PRESENTATION_STORAGE** : `local` or `s3`, define where the presentation files will be stored.
- **MAIL** : `local` or `smtp`, define how the mails will be sent.
_(only if s3 is used)_ :
- **AWS_ACCESS_KEY_ID** : Your AWS Access Key ID.
- **AWS_SECRET_ACCESS_KEY** : Your AWS Secret Access Key.
- **AWS_S3_BUCKET** : The name of the bucket where the presentation files will be stored.
- **AWS_S3_REGION** : The region where the bucket is located.
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
If you have configured `MAIL` to `local`, you can access to the mailbox at [`localhost:4000/dev/mailbox`](http://localhost:4000/dev/mailbox).
<!-- USAGE EXAMPLES -->
## 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](http://localhost:4000/dev/mailbox) if you have configured mail to be in local) and click on the link to get connected.
<!-- ROADMAP -->
## Roadmap
- [ ] Add Changelog
- [ ] Remove dead code
- [ ] Add additional tests for better coverage
- [ ] Add more docs
See the [open issues](https://github.com/ClaperCo/Claper/issues) for a full list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## 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 -->
## License
Distributed under the GPLv3 License. See `LICENSE.txt` for more information.
