/tolemy

Primary LanguageTypeScriptMIT LicenseMIT

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.

Product of the Month: April

Support us on Product Hunt

Calendso - The open source Calendly alternative | Product Hunt

Built With

Stay Up-to-Date

Calendso is currently in alpha. Watch releases of this repository to be notified for future updates:

calendso-star-github

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. More details on this can be found below under the Obtaining the Google API Credentials section.

Development Setup

  1. Clone the repo

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

  2. Install packages with yarn

    yarn install

  3. Copy .env.example to .env

  4. 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'
    If you don't know how to configure the DATABASE_URL, then follow the steps here

    1. Create a free account with Heroku.

    2. Create a new app.

    Google Chrome — CleanShotX | 2021-04-20 at 02 01 56

    1. In your new app, go to Overview and next to Installed add-ons, click Configure Add-ons. We need this to set up our database. image

    2. Once you clicked on Configure Add-ons, click on Find more add-ons and search for postgres. One of the options will be Heroku Postgres - click on that option. image

    3. Once the pop-up appears, click Submit Order Form - plan name should be Hobby Dev - Free.

    Google Chrome — CleanShotX | 2021-04-20 at 02 04 29

    1. Once you completed the above steps, click on your newly created Heroku Postgres and go to its Settings. image

    2. In Settings, copy your URI to your Calendso .env file and replace the postgresql://<user>:<pass>@<db-host>:<db-port> with it. image image

    3. To view your DB, once you add new data in Prisma, you can use Heroku Data Explorer.

  5. Set up the database using the Prisma schema (found in prisma/schema.prisma)

    npx prisma db push --preview-feature

  6. Run (in development mode)

    yarn dev

  7. Open Prisma Studio to look at or modify the database content:

    npx prisma studio

  8. Click on the User model to add a new user record.

  9. Fill out the fields (remembering to encrypt your password with BCrypt) and click Save 1 Record to create your first user.

  10. Open a browser to http://localhost:3000 and login with your just created, first user.

Upgrading from earlier versions

  1. Pull the current version:

    git pull

  2. Apply database migrations by running one of the following commands:

    In a development environment, run:

    npx prisma migrate dev

    (this can clear your development database in some cases)

    In a production environment, run:

    npx prisma migrate deploy

  3. Check the .env.example and compare it to your current .env file. In case there are any fields not present in your current .env, add them there.

    For the current version, especially check if the variable BASE_URL is present and properly set in your environment, for example:

    BASE_URL='https://yourdomain.com'

  4. Start the server. In a development environment, just do:

    yarn dev

    For a production build, run for example:

    yarn build
yarn start

  5. Enjoy the new version.

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. Make your changes
  4. Commit your changes (git commit -m 'Add some AmazingFeature')
  5. Push to the branch (git push origin feature/AmazingFeature)
  6. Open a pull request

Obtaining the Google API Credentials

  1. Open Google API Console. If you don't have a project in your Google Cloud subscription, you'll need to create one before proceeding further. Under Dashboard pane, select Enable APIS and Services.
  2. In the search box, type calendar and select the Google Calendar API search result.
  3. Enable the selected API.
  4. Next, go to the OAuth consent screen from the side pane. Select the app type (Internal or External) and enter the basic app details on the first page.
  5. In the second page on Scopes, select Add or Remove Scopes. Search for Calendar.event and select the scope with scope value .../auth/calendar.events, .../auth/calendar.readonly, .../auth/calendar and select Update.
  6. In the third page (Test Users), add the Google account(s) you'll using. Make sure the details are correct on the last page of the wizard and your consent screen will be configured.
  7. Now select Credentials from the side pane and then select Create Credentials. Select the OAuth Client ID option.
  8. Select Web Application as the Application Type.
  9. Under Authorized redirect URI's, select Add URI and then add the URI <CALENDSO URL>/api/integrations/googlecalendar/callback replacing CALENDSO URL with the URI at which your application runs.
  10. The key will be created and you will be redirected back to the Credentials page. Select the newly generated client ID under OAuth 2.0 Client IDs.
  11. Select Download JSON. Copy the contents of this file and paste the entire JSON string in the .env file as the value for GOOGLE_API_CREDENTIALS key.

Obtaining Microsoft Graph Client ID and Secret

  1. Open Azure App Registration and select New registration
  2. Name your application
  3. Set Who can use this application or access this API? to Accounts in any organizational directory (Any Azure AD directory - Multitenant)
  4. Set the Web redirect URI to <CALENDSO URL>/api/integrations/office365calendar/callback replacing CALENDSO URL with the URI at which your application runs.
  5. Use Application (client) ID as the MS_GRAPH_CLIENT_ID attribute value in .env
  6. Click Certificates & secrets create a new client secret and use the value as the MS_GRAPH_CLIENT_SECRET attriubte

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Special thanks to these amazing projects which help power Calendso: