https://github.com/trex-hub/safescrible
https://github.com/trex-hub/safescrible
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/trex-hub/safescrible
- Owner: Trex-Hub
- License: cc0-1.0
- Created: 2025-01-04T14:04:13.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-04T14:22:17.000Z (5 months ago)
- Last Synced: 2025-01-04T15:20:23.817Z (5 months ago)
- Language: TypeScript
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Next.js Notes App with Novel Editor
A modern note-taking application built with Next.js 15, TypeScript, and Novel Editor. Features a rich text editor with local storage using IndexedDB.
## Current Features
- 📝 Rich text editing with Novel Editor
- 💾 Local storage using IndexedDB
- 🎨 Clean UI with Tailwind CSS and shadcn/ui
- ⚡ Offline capability with IndexedDB
## Tech Stack
- [Next.js 15](https://nextjs.org/) - React framework
- [React 19](https://react.dev/) - UI library
- [TypeScript 5](https://www.typescriptlang.org/) - Type safety
- [Tailwind CSS 3](https://tailwindcss.com/) - Styling
- [shadcn/ui](https://ui.shadcn.com/) - UI components
- [Novel 0.5](https://novel.sh/) - Rich text editor
- [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) - Local storage
- [date-fns 4](https://date-fns.org/) - Date formatting
- [Lucide React](https://lucide.dev/) - Icons
## Getting Started
### Prerequisites
- Node.js 18.17 or later
- pnpm 8 (recommended) or npm
### Installation
1. Clone the repository:
```
git clone https://github.com/Trex-Hub/SafeScrible
cd SafeScrible
```
2. Install dependencies:
```
pnpm install
```
3. Run the development server:
```
pnpm dev
```
4. Open your browser and navigate to `http://localhost:3000` to see the app.
## Future Plans
- 🌙 Dark mode support
- 🔄 Data sync capabilities
- 🏷️ Note categorization and tags
- 📎 File attachments
- 🔍 Full-text search
- 📱 PWA support
- 🔒 End-to-end encryption
- 📤 Export/Import functionality
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.