cal.pub0.org/README.md

3.0 KiB

Logo

Calendso

The open-source Calendly alternative.
Learn more »

Slack · Website · Issues

About The Project

Calendso Screenshot

Let's face it: Calendly and other scheduling tools are awesome. It made our lives massively easier. We're using it for business meetings, seminars, yoga classes and even calls with our families. However, most tools are very limited in terms of control and customisations. That's where Calendso comes in. Self-hosted or hosted by us. White-label by design. API-driven and ready to be deployed on your own domain. Full control of your events and data. Calendso is to Calendly what GitLab is to GitHub.

Built With

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to be able to run Calendso.

  • Node.js
  • PostgreSQL
  • Yarn (recommended)

Development Setup

  1. Clone the repo
    git clone https://github.com/calendso/calendso.git
    
  2. Install packages with yarn
    yarn install
    
  3. Configure environment variables
    DATABASE_URL='postgresql://'
    GOOGLE_API_CREDENTIALS='secret'
    
  4. Set up the database using the Prisma schema
    npx prisma db push --preview-feature
    
  5. Run (in development mode)
    yarn dev
    

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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 MIT License. See LICENSE for more information.

Acknowledgements

Special thanks to these amazing projects which help power Calendso: