Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.93 KB

README.md

File metadata and controls

84 lines (55 loc) · 3.93 KB

Calendy - Easy appointment booking and management

Dashboard

Screen Shot 2021-03-02 at 10 41 58

This repository contains the source code for Calendy, the event scheduling application created by a team of four developers following Agile software development principles. It is a co-op project managed by Hatchways Inc.

This application enables easy scheduling workflow that aims to replace the traditional back and forth email and phone call confirming availability. The application would generate a sharable link for you where others can book appointments with you based on your predefined availability and update it accordingly. It will collect the required contact information and notify the attendee. As a host, you can easily see who have booked appointments with you and even connect your Google Calendar for a more automated workflow.

Core developers:

Add new Event Type

Screen Shot 2021-03-02 at 10 43 05

Project architecture

The project is built on MERN stack, with integration for Google OAuth social login, Stripe payment management, Amazon S3 storage bucket and Sendgrid email notification.

It is split into separate frontend and backend, managed by Yarn workspace. In development, the frontend client spins up a dev server that proxies API request to the independently running backend server. The two are unified upon deployment, where Heroku node.js runtime runs the build script, which bundles the client javascript into dist folder inside server, and then run start script to serve the client side javascript as well as handle all API request. The above two scripts are defined inside the top level package.json file.

Onboarding

Screen Shot 2021-03-02 at 10 41 18

Screen Shot 2021-03-02 at 10 42 24

Screen Shot 2021-03-02 at 10 42 37

Screen Shot 2021-03-02 at 10 42 46

Upgrade (Stripe API)

Screen Shot 2021-03-02 at 10 44 15

Screen Shot 2021-03-02 at 10 44 28

Photo Uploader (AWS)

Screen Shot 2021-03-02 at 10 45 30

Mobile View

Screen Shot 2021-03-02 at 10 46 39

Screen Shot 2021-03-02 at 10 46 46

Development and deployment

To start, navigate to the root of the project and run yarn install. (Please use yarn 1 instead of the newly released Yarn 2).

To spin up front end development server, run yarn workspace client run start.

To spin up backend server in development mode, run yarn workspace server run dev.

To build, run yarn run build. To serve the built project, run yarn run build.

Many of the services require credentials which are securely stored in each developer's computer.