Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jean-tinland/just-post-it
A simple note-taking app working with post-it
https://github.com/jean-tinland/just-post-it
javascript nextjs note-taking note-taking-app notes-app post-it react self-hosted typescript
Last synced: 11 days ago
JSON representation
A simple note-taking app working with post-it
- Host: GitHub
- URL: https://github.com/jean-tinland/just-post-it
- Owner: Jean-Tinland
- License: gpl-3.0
- Created: 2024-10-11T15:32:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T12:49:58.000Z (3 months ago)
- Last Synced: 2025-01-18T06:18:10.983Z (16 days ago)
- Topics: javascript, nextjs, note-taking, note-taking-app, notes-app, post-it, react, self-hosted, typescript
- Language: TypeScript
- Homepage:
- Size: 504 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# It's Just Post-It
Just Post-It is a simple note-taking app aiming to provide a novel experience by allowing the user to just drop notes on a free canvas.
## General notice
As this is a fork from a personal project presented [here](https://www.jeantinland.com/portfolio/draft-pad/) and detailed [in this blog post](https://www.jeantinland.com/blog/the-ultimate-note-app/), some basic features still need to be implemented before production use.
## Roadmap
Here are the planned features:
- Full description of all available features
- Add preferences tab in settings (spell check, auto correct, etc...)
- Add “Update available” indicator in settings' about tab
- Full i18n support (translations, reading direction, …)
- Keyboard shortcuts
- Global export of post-it
- Improve app responsive
- Make the app installable
- Demo website based on the real app
- …?
This list is non-exhaustive and expected to evolve.
## Dependencies & requirements
- npm
- node >= 18
- pm2
## Installation
Once you installed npm, node and pm2, follow these instructions.
```bash
# Clone this repo on your server in the desired location
git clone https://github.com/Jean-Tinland/just-post-it
# Go to the cloned folder
cd ./just-post-it
# This command will init the database
npm run init
```
## Configuration
```bash
# Duplicate the .env example
cp .env.example .env
```
Fill in the required information inside your .env:
```env
PROD_URL=https://your-production-url.com # the production url of your app
PORT=4000 # the port used by the app
JWT_SECRET=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx # the jwt secret, it can be anything like an UUID
JWT_DURATION=90 # the jwt token duration in days
PASSWORD=xxxxxxxx # your password
```
Just Post-It is now ready to run.
## Launching the app
Still in the `just-post-it` folder:
```bash
# This will start the app in the background with pm2
npm run launch
```
You can use either Apache or nginx to setup Just Post-It and make it accessible from the web.
> [!TIP]
> Once you launched `just-post-it`, pm2 will tell you that the process list is not saved. You can run `pm2 save` command in order to automaticaly restart all pm2 processes if your server is restarted.
## Updating the app
```bash
# This will stop the app, pull the latest changes and relaunch it
npm run update
```
> [!WARNING]
> Your Just Post-It app will be down during the update.