https://github.com/kangfenmao/vortexnotes
VortexNotes is a unique web-based note-taking software that offers a different approach to managing your notes.
https://github.com/kangfenmao/vortexnotes
docker-compose notes
Last synced: about 2 months ago
JSON representation
VortexNotes is a unique web-based note-taking software that offers a different approach to managing your notes.
- Host: GitHub
- URL: https://github.com/kangfenmao/vortexnotes
- Owner: kangfenmao
- License: mit
- Created: 2023-11-13T07:21:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T03:14:08.000Z (over 2 years ago)
- Last Synced: 2024-01-25T11:46:38.511Z (over 2 years ago)
- Topics: docker-compose, notes
- Language: TypeScript
- Homepage: https://vortexnotes.easys.run
- Size: 613 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VortexNotes
VortexNotes is a unique web-based note-taking software that offers a different approach to managing your notes.
## Overview
## Introduction
VortexNotes is designed to be a simple yet powerful note-taking tool. It provides users with a single entry point to submit new content without the need for note organization or management features. It serves as a "black hole" for your notes, where you can simply paste your content and let it disappear into the void.
## Features
- **Submit and Forget**: With VortexNotes, there is no need to worry about organizing or managing your notes. Simply paste your content into the application, and it will be absorbed into the void, never to be seen again.
- **Effortless Searching**: VortexNotes offers a search interface that allows you to quickly find specific notes. Despite the lack of note management, the powerful search feature enables you to retrieve your desired content effortlessly.
- **Clean and Minimalistic**: The user interface of VortexNotes is designed to be clean and minimalistic, focusing solely on the note submission and search functionalities. This ensures a distraction-free environment for your note-taking.
## Getting Started
To start using VortexNotes, follow these steps:
1. Clone this repository.
2. Install the necessary dependencies.
3. Run the application.
4. Access the application via the provided URL in your web browser.
5. Paste your content into the submission field and let it disappear into the void.
6. Use the search interface to retrieve your notes when needed.
## Docker compose
```yml
version: '3'
services:
vortexnotes:
container_name: vortexnotes
image: kangfenmao/vortexnotes:latest
ports:
- "10060:10060"
volumes:
- ./app/data/notes:/app/data/notes
- ./app/data/vortexnotes:/app/data/vortexnotes
```
Private access with passcode:
```yml
environment:
VORTEXNOTES_PASSCODE: 7a4019b7-4d5c-4eb5-8704-51a720e8cc4a
VORTEXNOTES_AUTH_SCOPE: show,create,edit,delete
```
If you only require a password to safeguard the writing actions.
```yml
environment:
VORTEXNOTES_PASSCODE: 7a4019b7-4d5c-4eb5-8704-51a720e8cc4a
VORTEXNOTES_AUTH_SCOPE: create,edit,delete
```
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
## License
This project is licensed under the [MIT License](LICENSE).