Skip to content

devalexwhite/Kai

Repository files navigation

Contributors Forks Stargazers Issues GNU GPLv3 LinkedIn


Logo

Kai

Free platform for organizing groups, meetups and events.
Explore the docs »

Website · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

Kai Screen Shot

Kai is an open-source, free to use platform for hosting your community groups, meetups and events. Kai is designed to be the home for community groups, reducing the friction of starting a group.

Kai was created to provide a free alternative to services that cost hundreds of dollars a year just to host meetups.

Currently, Kai supports the following features:

  • Create and join groups in your city
  • Create and RSVP to events
  • Follow groups via RSS to keep updated on new events
  • Communicate with groups members via the discussions board
  • Download iCal files to remind yourself of events
  • Discover upcoming groups to join

(back to top)

Built With

  • HTMX
  • Slim Framework

(back to top)

Deployment Status

Laravel Forge Site Deployment Status

(back to top)

Getting Started

DDEV is the fastest way to get up and running with Kai development.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • ddev
    brew install orbstack docker
    brew install ddev/ddev/ddev
    mkcert -install

Installation

  1. Clone the repo
    git clone https://github.com/devalexwhite/Kai.git
  2. Start ddev
    cd kai
    ddev start
  3. Visit the local URL https://kai.ddev.site/

(back to top)

Roadmap

  • Email service integration for event and RSVP notifications
  • Event RSVP limits
  • Closed groups that require approval to join
  • Customizable group pages

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

(back to top)

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

(back to top)

Top contributors:

contrib.rocks image

License

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

(back to top)

Contact

Alex White - @alextheuxguy - hi@thatalexguy.dev

Project Link: https://github.com/devalexwhite/Kai

(back to top)