https://github.com/korigamik/noted

A minimalist note-taking and sharing app
https://github.com/korigamik/noted

deno fresh jwt-authentication mongodb notes-app preact

Last synced: about 2 months ago
JSON representation

A minimalist note-taking and sharing app

• Host: GitHub
• URL: https://github.com/korigamik/noted
• Owner: KorigamiK
• License: mit
• Created: 2022-08-25T20:06:27.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-04T11:08:24.000Z (almost 4 years ago)
• Last Synced: 2025-02-07T14:23:31.424Z (over 1 year ago)
• Topics: deno, fresh, jwt-authentication, mongodb, notes-app, preact
• Language: TypeScript
• Homepage: https://noted.deno.dev
• Size: 1.27 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

Noted


![Version 0.1.1](https://img.shields.io/badge/version-v0.1.1-green.svg)

A minimalist note-taking as well as sharing app.

## Table of Contents

- [Table of Contents](#table-of-contents)

- [Showcase](#showcase)

  - [Home](#home)

  - [Sign Up](#sign-up)

  - [Log In](#log-in)

  - [Success](#success)

  - [Dashboard](#dashboard)

  - [Create](#create)

  - [Owned Notes](#owned-notes)

  - [Public Notes](#public-notes)

  - [Error](#error)

- [Highlights](#highlights)

- [Development](#development)

- [Known Issues](#known-issues)

- [License](#license)

## Showcase

### Home

  ![Home](.github/images/home.png)

### Sign Up

  ![Home](.github/images/signup.png)

### Log In

  ![Login](.github/images/login.png)

### Success

  ![Success](.github/images/success.png)

### Dashboard

  ![Dashboard](.github/images/dashboard.png)

### Create

  ![Create](.github/images/create.png)

### Owned Notes

  ![Owned Notes](.github/images/ownedNote.png)

### Public Notes

  ![Public Notes](.github/images/publicNote.png)

  

### Error

  ![Error](.github/images/error.png)

## Highlights

- Everything in TypeScript

- MongoDB with completely typed schema

- Persistent sessions using JSON Web Tokens (JWT)

- Free deployment using Deno deploy

- Public notes can be shared with anyone

- Using twind instead of tailwind

- Heart your favorite notes to view them later

## Development

- Create a .env file in the root directory and set the following variables:

  - `__MONGO_DB_URI__` = `"mongodb+srv://:@/?authMechanism=SCRAM-SHA-1"`

  - ` __DEVELOPMENT__ `= `True` If you want to persist logins across server restarts

- Start the project:

```bash

deno task start

```

This will watch the project directory and restart as necessary.

## Known Issues

- Web workers are not supported in Deno deploy. This means that async Bcrypt is not supported. This is a temporary issue and will be fixed in the future.

  - [Relevant Issue](https://github.com/JamesBroadberry/deno-bcrypt/issues/26)

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Made with Fresh](https://fresh.deno.dev/fresh-badge-dark.svg)](https://fresh.deno.dev)