dehboris / calendso Goto Github PK

The open-source Calendly alternative.
Learn more »

Slack · Website · Issues

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.

• Next.js
• React
• Tailwind

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

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.

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'
   

5. Set up the database using the Prisma schema

   npx prisma db push --preview-feature

6. Run (in development mode)

   yarn dev

7. Open the prisma schema (found in prisma/schema.prisma) with Prisma Studio
8. Click on the user model to allow 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 first user.

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

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

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

Special thanks to these amazing projects which help power Calendso:

• Next.js
• Day.js
• Tailwind CSS