Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yuri2peter/aignition

🔥Notes that spark your creativity.
https://github.com/yuri2peter/aignition

ai markdown note-taking react self-hosted

Last synced: about 2 months ago
JSON representation

🔥Notes that spark your creativity.

Host: GitHub
URL: https://github.com/yuri2peter/aignition
Owner: yuri2peter
License: apache-2.0
Created: 2024-05-29T16:13:24.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-10-30T01:25:06.000Z (2 months ago)
Last Synced: 2024-10-30T03:57:07.047Z (2 months ago)
Topics: ai, markdown, note-taking, react, self-hosted
Language: TypeScript
Homepage:
Size: 2.61 MB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![image](https://github.com/yuri2peter/picx-images-hosting/raw/master/logo_banner.2h89fgamei.webp)

---- Notes that spark your creativity.

中文

## 📖 Table of Contents

- [💡 Introduction](#-Introduction)
- [🔮 Features](#-Features)
- [🚀 Deployment](#-Deployment)
- [📘 User Guide](#-User-Guide)
- [🧰 Maintenance](#-Maintenance)
- [❓ FAQ](#-FAQ)
- [🙏 Acknowledgement](#-Acknowledgement)

## 💡 Introduction

**AIgnition** is an intuitive, open-source note-taking web app, powered by AI to simplify and enhance your note-taking experience.

![multi-mockup](https://github.com/yuri2peter/picx-images-hosting/raw/master/multi-mockup.5c0xn7y36a.webp)

## ✨ Features

### Editor

- Markdown WYSIWYG
- Live preview
- HTML block rendering
- Code block syntax highlighting

### AI Engine

- Support OpenAI API and Gemini API
- Q/A chat
- Autocomplete
- Rewrite

### Guest Mode

- Share your notes with others
- Comment system

### Self-Hosted

- Privacy first
- Pure JS based
- Deploy with Docker

### Multi Devices Support

- Desktop
- Tablet
- Mobile

## 🚀 Deployment

Docker compose is the simplest way to deploy AIgnition.

```yml
# https://hub.docker.com/repository/docker/yuri2/aignition/general
# /YOUR_PATH/aignition/docker-compose.yml
version: '3.8'
services:
aignition:
image: 'yuri2/aignition'
restart: unless-stopped
volumes:
- ./runtime:/dist/runtime
environment:
# The port that the web server listens on.
- SERVER_PORT=3000
ports:
- 3000:3000
```

## 📘 User Guide

Please visit the [User Guide](/assets/server/📘%20AIgnition%20User%20Guide/1.%20🎉%20Quick%20Start/1.1.%20⚙%EF%B8%8F%20Basic%20Setups.md) for more details.

## 🧰 Maintenance

### Software Update

```bash
cd /YOUR_PATH/aignition
docker-compose pull
docker-compose up -d
```

### Backup Data

- `runtime` is the data that AIgnition stores. DO NOT lose it.
- Use `Export data > Save archive` and `Import data > From archive` to backup and restore data in the `Data` panel.

### Log File

You can check the log file(useful for troubleshooting and password recovery) in the `runtime/logs`.

## ❓ FAQ

### What if I deleted some important notes without backups?

Your data is automatically backed up every 30 minutes. You can find these backups in the `runtime/data/db/main_backup` directory. To restore your data, simply replace the contents of the `main.db` file with the contents of the desired backup file, then restart the app manually.

> Uploads are NOT backup automatically.

### Is AIgnition open source?

AIgnition is completely open source, and contributions are welcome.

### Do I need to pay for it?

All features are free, even for commercial use.

## 🙏 Acknowledgement

The birth of AIgnition is inseparable from many open source projects and contributors, please refer to the `package.json`.

Welcome to join us and contribute code to AIgnition together.