Skip to main content

Installing Calendso

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.

  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.