Skip to content

Commit c1d85ba

Browse files
authored
Merge pull request #16 from PriDebnath/feat/dexie
Feat/dexie
2 parents 5d0df02 + 362e412 commit c1d85ba

37 files changed

Lines changed: 1210 additions & 620 deletions

β€Ž.github/workflows/deploy_frontend_to_pages.ymlβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ jobs:
3939
run: |
4040
cd frontend
4141
pnpm run build
42+
43+
- name: Inject build timestamp
44+
run: |
45+
echo '{ "lastDeployed": "'$(date -u +'%Y-%m-%dT%H:%M:%SZ')'", "deployedBy": "Pritam Debnath" }' \
46+
> frontend/dist/last-deployed.json
4247
4348
- name: Setup Pages
4449
uses: actions/configure-pages@v5

β€ŽCONTRIBUTING.txtβ€Ž

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
Contributing to Notes
2+
=====================
3+
4+
Thank you for your interest in contributing to Notes!
5+
This document is aimed at developers and contributors who want to work on the project.
6+
7+
8+
Project Structure
9+
-----------------
10+
11+
- Root
12+
- `backend` – Bun/TypeScript backend (database, API, migrations)
13+
- `frontend` – Vite + React frontend (Quotes Keeper UI)
14+
- `pnpm-workspace.yaml` – Monorepo configuration
15+
16+
17+
Frontend (Vite + React)
18+
-----------------------
19+
20+
Main tech stack:
21+
22+
- Vite + React + TypeScript
23+
- @tanstack/router for routing
24+
- @tanstack/react-query for data fetching and caching
25+
- Dexie / IndexedDB for local quote and tag storage
26+
- Styled UI components, theming, and backgrounds for a pleasant reading experience
27+
28+
29+
Running the Frontend Locally
30+
----------------------------
31+
32+
1. Install pnpm if you do not have it:
33+
- https://pnpm.io/installation
34+
35+
2. Install dependencies (from the repo root):
36+
37+
- `cd frontend`
38+
- `pnpm install`
39+
40+
3. Start the development server:
41+
42+
- `pnpm dev`
43+
44+
4. Open the app in your browser (Vite will print the URL, usually http://localhost:5173).
45+
46+
47+
Building & Deployment (Frontend)
48+
--------------------------------
49+
50+
- The app is configured to build with Vite:
51+
52+
- `cd frontend`
53+
- `pnpm run build`
54+
55+
- The GitHub Actions workflow `.github/workflows/deploy_frontend_to_pages.yml` builds the frontend
56+
and deploys the contents of `frontend/dist` to GitHub Pages.
57+
58+
- A `last-deployed.json` file is injected during the build and can be read by the app to show
59+
the last deployment time in the UI.
60+
61+
62+
Backend
63+
-------
64+
65+
- The `backend` folder contains a Bun/TypeScript API with Drizzle ORM and migrations.
66+
- You can inspect `backend/package.json` for available scripts (dev, build, etc.) and run them with Bun or pnpm,
67+
depending on your setup.
68+
69+
70+
Code Style & Guidelines
71+
------------------------
72+
73+
- Keep components small and focused.
74+
- Prefer hooks and stores that are already in use (`frontend/src/hook`, `frontend/src/store`).
75+
- Follow existing naming conventions for files and components.
76+
- Run linting/formatting tools if configured before opening a pull request.
77+

β€ŽREADME.mdβ€Ž

Lines changed: 57 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,67 @@
11
## πŸ”΄ Demo
22

3-
### πŸ–ΌοΈ Screenshot
3+
### πŸ”΄ πŸ–ΌοΈ Screenshot
44

5-
<a href="https://pridebnath.github.io/prink">
6-
<img src="" alt="Coming soon" />
5+
<a href="https://pridebnath.github.io/Notes">
6+
<img height="480" src="frontend/public/images/list.page.png" />
77
</a>
88

9-
### πŸŽ₯ Video
109

10+
### πŸ”΄ πŸŽ₯ Video
1111

12-
⬇️[Demo Video Download](public/videos/prink-2.mp4)
12+
Coming soon
1313

14+
⬇️[Demo Video Download](Coming soon.mp4)
1415

15-
### ↗️ Link
16-
https://pridebnath.github.io/Quotes-Keeper-3
1716

18-
---
17+
### πŸ”΄ ↗️ Link
18+
https://pridebnath.github.io/Notes
19+
20+
21+
---
22+
Notes
23+
=====
24+
25+
**Turn scattered notes into a personal library you actually want to revisit.**
26+
27+
Most note apps become a graveyard: you capture ideas, quotes, and thoughts, and never see them again.
28+
Notes is built to make your notes feel like a beautifully designed collection you enjoy browsing,
29+
not a dusty archive you forget about.
30+
31+
32+
What makes it different?
33+
------------------------
34+
35+
- **Cards that invite reading**: Notes are shown as warm, tactile cards instead of flat lists,
36+
so even old notes feel fresh when you scroll past them.
37+
- **Backgrounds and moods**: Switch between subtle textures and themes so your workspace feels
38+
more like a desk you enjoy sitting at than a plain white screen.
39+
- **Focus on the words, not the UI**: The interface gets out of the way so your notes – quotes,
40+
thoughts, drafts – are the star of the page.
41+
- **Organized without being overwhelming**: Tags, filters, and sorting are there when you need them,
42+
but they don’t scream for attention when you just want to read.
43+
- **Fast and local-first**: Notes load instantly and feel responsive, even with a growing collection.
44+
45+
46+
Perfect for
47+
-----------
48+
49+
- **Readers** who highlight everything and want a beautiful place to keep the best lines.
50+
- **Writers and creators** who collect ideas, hooks, and snippets to reuse later.
51+
- **Thinkers and journalers** who want a calmer, more delightful space for short notes.
52+
53+
54+
How it feels to use
55+
-------------------
56+
57+
- You open the app and immediately see a wall of cards that feels curated, not cluttered.
58+
- You scroll and rediscover things you had forgotten you saved – like browsing a shelf of favorite books.
59+
- Changing the background or theme feels like rearranging your desk, not configuring software.
60+
61+
62+
Try it
63+
------
64+
65+
- Open the app, add a single quote or thought that matters to you, and see how it looks on a card.
66+
- Tag a few notes and play with different views to find a layout that matches your mood.
67+
- Come back tomorrow and notice how easy it is to fall back into reading what you’ve saved.

β€Žfrontend/index.htmlβ€Ž

Lines changed: 69 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,71 @@
11
<!doctype html>
22
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8" />
5-
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Notes</title>
8-
9-
<link rel="preconnect" href="https://fonts.googleapis.com">
10-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
11-
<link href="https://fonts.googleapis.com/css2?family=Gabriela&family=Playwrite+DE+Grund:wght@100..400&display=swap" rel="stylesheet">
12-
13-
<link rel="preconnect" href="https://fonts.googleapis.com">
14-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
15-
<link href="https://fonts.googleapis.com/css2?family=Playwrite+DE+Grund:wght@100..400&display=swap" rel="stylesheet">
16-
17-
<link rel="preconnect" href="https://fonts.googleapis.com">
18-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
19-
<link href="https://fonts.googleapis.com/css2?family=Merienda:wght@300..900&family=Playwrite+DE+Grund:wght@100..400&family=Rouge+Script&display=swap" rel="stylesheet">
20-
21-
</head>
22-
<body class="font-playwrite-de-grund">
23-
<div id="root"></div>
24-
<script type="module" src="/src/main.tsx"></script>
25-
</body>
26-
</html>
3+
4+
<head>
5+
<meta charset="UTF-8" />
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
9+
<!-- Primary Meta Tags -->
10+
<title>Notes – A Calm, Beautiful Space for Your Thoughts</title>
11+
<meta
12+
name="description"
13+
content="Notes is a calm, beautiful notes app that turns scattered ideas into a personal library you actually want to revisit."
14+
/>
15+
<meta
16+
name="keywords"
17+
content="notes app, notes, personal knowledge base, note cards, digital notebook, writing app, journaling app"
18+
/>
19+
<meta name="robots" content="index,follow" />
20+
21+
<!-- Favicon -->
22+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
23+
24+
<!-- Open Graph / Facebook -->
25+
<meta property="og:type" content="website" />
26+
<meta property="og:title" content="Notes – A Calm, Beautiful Space for Your Thoughts" />
27+
<meta
28+
property="og:description"
29+
content="Capture ideas, thoughts, and snippets in a warm, card-based notes app designed for rereading, not forgetting."
30+
/>
31+
<!--
32+
Replace this URL with your real production URL (GitHub Pages or custom domain)
33+
Example: https://your-username.github.io/Quotes-Keeper-3/
34+
-->
35+
<meta property="og:url" content="/" />
36+
<!--
37+
If you add a social preview image, update this path.
38+
Example: /social-card.png
39+
-->
40+
<meta property="og:image" content="/vite.svg" />
41+
42+
<!-- Twitter -->
43+
<meta name="twitter:card" content="summary_large_image" />
44+
<meta name="twitter:title" content="Notes – A Calm, Beautiful Space for Your Thoughts" />
45+
<meta
46+
name="twitter:description"
47+
content="A distraction-light notes app that makes your saved ideas feel like a curated collection instead of a cluttered list."
48+
/>
49+
<meta name="twitter:image" content="/vite.svg" />
50+
51+
<!-- Theme Color -->
52+
<meta name="theme-color" content="#0f172a" />
53+
54+
<!-- Fonts -->
55+
<link rel="preconnect"
56+
href="https://fonts.googleapis.com">
57+
<link rel="preconnect"
58+
href="https://fonts.gstatic.com"
59+
crossorigin>
60+
<link href="https://fonts.googleapis.com/css2?family=Gabriela&family=Merienda:wght@300..900&family=Playwrite+DE+Grund:wght@100..400&display=swap"
61+
rel="stylesheet" />
62+
63+
</head>
64+
65+
<body class="font-playwrite-de-grund">
66+
<div id="root"></div>
67+
<script type="module"
68+
src="/src/main.tsx"></script>
69+
</body>
70+
71+
</html>

β€Žfrontend/package.jsonβ€Ž

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
{
22
"name": "frontend",
3+
"description": "Notes is a calm, beautiful notes app that turns scattered ideas into a personal library you actually want to revisit.",
4+
"keywords": [
5+
"notes",
6+
"notes app",
7+
"notes keeper",
8+
"notes organizer",
9+
"notes collection",
10+
"notes notebook",
11+
"personal knowledge base",
12+
"note cards",
13+
"digital notebook",
14+
"writing app",
15+
"journaling app"
16+
],
17+
"author": "Pritam Debnath",
18+
"repository": {
19+
"type": "git",
20+
"url": "https://github.com/pridebnath/notes.git"
21+
},
22+
"homepage": "https://pridebnath.github.io/notes/",
323
"private": true,
424
"version": "0.0.0",
525
"type": "module",
-199 KB
Binary file not shown.
99.8 KB
Loading
-132 KB
Binary file not shown.
26.3 KB
Loading
-102 KB
Binary file not shown.

0 commit comments

Comments
Β (0)