cal.pub0.org

3.9 KiB

Raw Blame History

Calendso

The open-source Calendly alternative.
Learn more »

Slack · Website · Issues

About The Project

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)

You will also need Google API credentials. You can get this from the Google API Console. Simply create a new project, set the OAuth to use the calendar.events read and write permissions, and then set the callback URL to <CALENDSO URL>/api/integrations/googlecalendar/callback.

Development Setup

Clone the repo

git clone https://github.com/calendso/calendso.git

Install packages with yarn
```
yarn install
```
Copy .env.example to .env
Configure environment variables in the .env file. Replace <user>, <pass>, <db-host>, <db-port> with their applicable values
```
DATABASE_URL='postgresql://<user>:<pass>@<db-host>:<db-port>'
GOOGLE_API_CREDENTIALS='secret'
```
Set up the database using the Prisma schema
```
npx prisma db push --preview-feature
```
Run (in development mode)
```
yarn dev
```
Open the prisma schema (found in prisma/schema.prisma) with Prisma Studio
Click on the user model to allow add a new user record.
Fill out the fields remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/) and click Save 1 Record to create your first user.
Open a browser to http://localhost:3000 and login with your first user.

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.

Fork the project
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
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:

3.9 KiB Raw Blame History