cardi - GitLite

KO | EN

gitlite — search

#python #go #android #rust #nodejs #macos #java #awesome #kubernetes #awesome-list #security #mcp #openai #open-source

cardi

(★ 83)

A full-featured, static-generated PWA for notes stored in privately owned DynamoDB tables

파일 탐색기

최종 버전 다운로드 (.zip)

- - deploy.yaml
  - test.yaml
- - icon-maskable-180.png
  - icon-maskable-192.png
  - icon-maskable-512.png
  - icon-xparent-32.png
  - icon-xparent-512.png
- aws-sdk-2.712.0.min.js
- favicon.png
- global.css
- index.html
- manifest.json
- nunito-bold.woff2
- nunito-bolditalic.woff2
- nunito-italic.woff2
- nunito-regular.woff2
- nunito.css
- offline.html
- pica-6.1.1.min.js
- serviceworker.js
- - client.js
- - CardLarge.svelte
  - ChangeTagModal.svelte
  - Checkbox.svelte
  - Footer.svelte
  - Icon.svelte
  - MessageGrid.svelte
  - MessageTile.svelte
  - Modal.svelte
  - ModalCardLarge.svelte
  - MonthPicker.svelte
  - Navbar.svelte
  - NewSnippetModal.svelte
  - Searchbar.svelte
  - Sidebar.svelte
  - SidebarItem.svelte
  - Spinner.svelte
  - TagSelect.svelte
  - Toolbar.svelte
  - ToolbarButton.svelte
- - pipeline.js
  - querystore.js
  - search.js
  - stemmer.js
  - storeutil.js
  - util.js
- - LogIn.svelte
  - Overview.svelte
- App.svelte
- constants.js
- main.js
- store.js
- integration.js
.editorconfig
.gitignore
LICENSE
package-lock.json
package.json
postcss.config.js
README.md
rollup.config.js
schema.json
screenshot.png
tailwind.config.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/pickledish/cardi

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd cardi

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Cardi Notes

![Build and Test](https://github.com/pickledish/cardi/workflows/Build%20and%20Test/badge.svg)
[![Netlify Status](https://api.netlify.com/api/v1/badges/f3116a5c-0e08-4ac5-879b-914559877b01/deploy-status)](https://app.netlify.com/sites/sad-yonath-ed271d/deploys)

[Cardi Notes](https://www.cardinotes.app/) is a new kind of note keeping tool -- with all data privately stored in your own AWS account, accessible on any device without maintaining your own server, completely open-source and free to use.

![Cardi](https://raw.githubusercontent.com/pickledish/cardi/master/screenshot.png)

## Overview

You can think of Cardi as Google Keep, but without the Google.

My goal in creating and open-sourcing Cardi is to make it **as easy as possible** to move personal note-keeping off of a third-party cloud and into a private data store to which only you have access.

The implementation is currently more technical than I'd like -- it requires a personal AWS account, where notes are stored in a private DynamoDB table and queried directly by a static frontend using AWS access keys like a username and password. However, I think it's unique at least, and the advantage of a self-hosted note application that's both maintenance-free and actually-free is undeniable.

You can read more about Cardi in [the wiki](https://github.com/pickledish/cardi/wiki/About).

## Quick Start

In order to start using Cardi to keep notes, the process is short and simple:

1. Make sure you've created a personal AWS account
    - If you're not up for learning a bit about AWS, that's ok, but may want to try a different solution for now
1. Follow along with the [setup guide](https://github.com/pickledish/cardi/wiki/Setup) to create necessary AWS access keys
    - These keys are only ever stored in your own browser and sent to AWS, **never anywhere else**
1. Visit [cardinotes.app](https://www.cardinotes.app) and allow it to use the credentials you just created
    - This will automatically create the necessary DynamoDB tables when you first log in

## Application Features

- Full markdown support in note content
- Assign a note to any number of "boards" (i.e. tags) for simple organization
- Ability to archive notes that are no longer relevant
- Automatic fetching of HTML titles and images for URL notes
- Quick filters based on board or date of note creation
- Support for batch archival and tag modification
- Works in all major browsers, and phones as a Progressive Web App
- Dark mode!

## Technical Features

- Fully automated integration testing and deployment
- Statically generated site (see [JAMStack](https://jamstack.org/) for more info), hosted on Netlify
- Minimal bundle size, with no tracking or analytics
- All benefits of having data stored in a DynamoDB table, including:
  - Point in Time Recovery available
  - Fully encrypted at rest
  - Easy export and restore of notes to JSON or CSV
  - Easy direct administration when needed

## Development

**Requires `npm` version 6.14 or greater to build**

This project is mainly a single-page application, taking advantage of the fantastic open-source libraries [Svelte](https://svelte.dev) to define and build the individual components, [Tailwind](https://tailwindcss.com) for the styling, and [Rollup.js](https://rollupjs.org) as the build system and bundler. This is a pretty standard javascript setup, so you can use `npm install` to install dependencies for the project and `npm run dev` to start a local (live-reloading) server for real-time development.

To create a release-ready bundle for your own deployment of Cardi, run `npm run build`, which will compile all Svelte components to javascript, then render the JS bundle into `public/build`.

Actual releases to [cardinotes.app](https://www.cardinotes.app) are handled via a [Github action](./.github/workflows/deploy.yaml), triggering whenever a commit to `master` is tagged, which builds the site and publishes the artifact to [Netlify](https://www.netlify.com), which hosts the static site and handles SSL certs.

## Contributing

I'm happy to accept any new features or bug fixes to this repository, as long as they don't change the core functionality or requirements of Cardi (whole application is deployed as a static bundle, all application data is stored decentralized in a user's personal cloud account).

In order to contribute, the process should be much the same as for other Github repositories -- fork this repo, make your changes, push, then create a PR against this repo from your fork. I'm still actively working on this project, so I'll be sure to keep an eye on the PRs and get back to you soon!

## License

All code in this repository, unless otherwise stated, is open source under the [GNU GPLv3 license](./LICENSE).