![]()
Some checks failed
Build and Push to GHCR & Docker Hub / build-and-push (push) Has been cancelled
|
||
---|---|---|
.github/workflows | ||
backend | ||
frontend | ||
.env.example | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md |
reflectiv
reflectiv is an open source app to help you generate monthly PDF reflection diaries with AI from chatGPT chats.
Disclaimer • Wiki • Installation • Sponsors
Key Features
- AI-Powered journaling prompts generation
- Support for both cloud-based APIs and local LLMs via Ollama
- Self-Hosted by design
- Simple PDF export
⚠️ Disclaimer
This project is a personal reflection tool, not a substitute for professional help. If you're struggling, please consider reaching out to a counselor, therapist, or a trusted friend. You're not alone.
📚 Wiki
Read the wiki before opening new issues. The question you have might be answered over there.
🛠️ Installation
Note
To run this application, you'll need Docker with docker-compose.
Start off by showing some ❤️ and give this repo a star. Then from your command line:
# Create a new directory
> mkdir reflectiv
> cd reflectiv
# Create docker-compose.yml and copy the example contents into it
> touch docker-compose.yml
> nano docker-compose.yml
# Create .env and copy the example contents into it. Configure as you see fit
> touch .env
> nano .env
docker-compose.yml
services:
app:
image: ghcr.io/giacomo-folli/reflectiv:latest
container_name: reflectiv
ports:
- "3000:3000"
env_file:
- .env
environment:
- NODE_ENV=production
- DATA_DIR=/home/node/app/data
volumes:
- reflectiv_data:/home/node/app/data
restart: unless-stopped
volumes:
reflectiv_data:
.env
Important
Every time you change the .env file, you need to restart your container for the changes to take effect.
> curl -o .env https://raw.githubusercontent.com/giacomo-folli/reflectiv/main/.env.example
> nano .env
Running the Application
To run the application run the following command:
> docker compose up -d
The docker container is now running; navigate to http://localhost:3000/
to access the app.
🗺️ Locales and translations
Currently, the app is translated to:
- 🇬🇧 English
- 🇮🇹 Italian
If you want to see a new locale added, please open an issue
Only do this if you are willing to help on the actual translation 🙃.
💡 Feature request?
For any feedback, help or feature requests, please open a new issue.
🛠️ Local setup
Run the following commands to setup the project on your local machine
> git clone git@github.com:your-name/your-fork.git
> npm i
> npm run dev