|
1 | 1 | # Compass Calendar |
2 | 2 |
|
3 | | -A simple app that helps you manage your time. |
| 3 | +A simple calendar that helps you manage your time. |
4 | 4 |
|
5 | | -## Why Try Compass? |
| 5 | +## Why try compass? |
6 | 6 |
|
7 | | -### You'll get more done: |
| 7 | +### You'll get more done |
8 | 8 |
|
9 | 9 | - The **first-class shortcuts** will make it a breeze to stay on top of your schedule. |
10 | 10 | - The **minimal UI** will help you focus on what matters: your events. |
11 | 11 | - The **Google Calendar two-way sync** will ensure you don't miss anything. |
12 | 12 |
|
13 | | -### It'll be around for the long-term: |
| 13 | +### It'll be around for the long-term |
14 | 14 |
|
15 | 15 | - **We're bootstrapped.** While VC-backed teams think in terms of months and funding rounds, we think in terms of decades and profit. We don't need to make $1B in 5 years or sell your data to an acquirer. As long as we keep users like you happy, we'll be fine. |
16 | | -- **We have a plan**: Our long-term [vision](https://alpaca-ty.notion.site/about-us) will keep us busy for generations. Our practical roadmap and focus on profitability will keep our feet on the ground along the way. |
| 16 | +- **We have a plan.** Our long-term [vision](https://alpaca-ty.notion.site/about-us) will keep us busy for generations. Our practical roadmap and focus on profitability will keep our feet on the ground along the way. |
17 | 17 |
|
18 | 18 | ### It'll help others |
19 | | -We donate 10% of revenue to support mental health programs in our home city of Bozeman, Montana. Your support helps us help others in need. |
| 19 | +We donate 10% of revenue to support mental health programs in our home city of Bozeman, Montana. Your support helps us support others in need. |
20 | 20 |
|
21 | 21 | ## Features |
22 | 22 |
|
23 | | -- Recurring events |
24 | | -- Command palette |
25 | | -- Event tagging, resizing, duplicating, reordering |
26 | | -- Drag & drop |
27 | | -- Google Calendar sync |
28 | | -- User sessions |
| 23 | +Cool things you can do with in Compass |
29 | 24 |
|
30 | | -## The Limitations |
| 25 | +- Find the perfect slot for an event with your keyboard: `SHIFT` + `↑` `↓` `←` `→` |
| 26 | +- Do everything from the cmd palette |
| 27 | +- Edit events smoothly |
| 28 | +- Google Calendar sync |
31 | 29 |
|
32 | | -Things we don't support (yet): |
| 30 | +Things you can't do in Compass (yet): |
33 | 31 |
|
34 | | -- Outlook or iCal |
35 | | -- Sharing, reminders, locations |
36 | | -- Mobile app |
| 32 | +- See attendees, reminders, locations, and meeting links |
| 33 | +- See your Outlook events |
37 | 34 |
|
38 | | -## Tech Stack |
| 35 | +## Tech stack |
39 | 36 |
|
40 | 37 | - **Frontend**: React, Zustand, TanStack, Tailwind |
41 | 38 | - **Backend**: Node, Express, MongoDB |
42 | | -- **Integrations**: Google Calendar API, Google OAuth2 |
43 | 39 | - **Testing**: Bun, React Testing Library, Playwright |
44 | 40 |
|
45 | | -## Getting Started |
46 | | - |
47 | | -### Option 1: Try Compass Online |
48 | | - |
49 | | -[compasscalendar.com](https://www.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) ← No signup required. |
50 | | - |
51 | | -### Option 2: Run Compass Locally |
52 | | - |
53 | | -```bash |
54 | | -# Quick start |
55 | | -bun install |
56 | | -cp compass.example.yaml compass.yaml # then replace the placeholder values |
57 | | -bun run dev:web # Frontend on http://localhost:9080 |
58 | | -bun run dev:backend # Backend on http://localhost:3000 |
59 | | - |
60 | | -# Testing |
61 | | -bun run test:core && bun run test:web && bun run test:backend |
62 | | -bun run test:e2e |
63 | | -``` |
64 | | - |
65 | | -### Option 3: Self-host Compass |
66 | | - |
67 | | -Run Compass on a server you control to keep everything on your infrastructure. |
| 41 | +## Getting started |
68 | 42 |
|
69 | | -See [the self-hosting guide](./docs/self-hosting/README.md) for instructions. |
| 43 | +| Option | Description | Instructions | |
| 44 | +|---|---|---| |
| 45 | +| **1. Try Compass web** | Use Compass now (no signup required). | [compasscalendar.com](https://www.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) | |
| 46 | +| **2. Run Compass locally** | Run Compass on your machine. | `bun install`<br><br>`cp compass.example.yaml compass.yaml` <br><br>`bun run dev:web`<br><br>`bun run dev:backend`<br><br>Open [http://localhost:9080](http://localhost:9080). | |
| 47 | +| **3. Self-host Compass** | Run Compass on your server. | See [the self-hosting guide](./docs/self-hosting/README.md). | |
70 | 48 |
|
71 | 49 | ## Resources |
72 | 50 |
|
|
0 commit comments