Skip to content

himanshupapola/InKeep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

40 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“” InKeep | Your Digital Diary

InKeep is a fullstack web application designed to help users securely write, save, and manage personal diary entries. Built with a React frontend and Spring Boot backend.

๐Ÿงฑ Tech Stack

Layer Technology
Frontend React, Vite
Backend Spring Boot, Java 24
Database MySQL
OTP Store Upstash Redis
Email Brevo (Sendinblue)
Auth Spring Security, OTP (Email)
Deploy Railways, Jenkins CI/CD, AWS

๐Ÿ“ธ Data Flow Diagram (Overview)

DFD.

๐ŸŒ„ Website Showcase

Website Showcase

๐Ÿš€ Getting Started

๐Ÿ”ง Prerequisites

  • Java 24
  • Node.js 18+
  • Maven
  • Vite
  • Git

๐Ÿ“ฆ Installation & Setup

1. Clone the Repository

git clone https://github.com/himanshupapola/InKeep.git
cd InKeep

2. Backend Setup (Spring Boot)

cd backend
configure .env file
Run main file

3. Frontend Setup (React + Vite)

cd ../frontend
npm install
configure .env file
npm run dev

๐Ÿ›ก๏ธ Environment Variables

1. Frontend (frontend/.env)

VITE_API_URL=your_backend_url
VITE_OPENWEATHER_API_KEY=your_openweather_key
VITE_GEONAMES_USERNAME=your_geonames.org_name

2. Backend (backend/.env)

DB_URL=your_sql_server_url
DB_USERNAME=your_db_user
DB_PASSWORD=your_db_password
BREVO_API_KEY=your_brevo_key
REDIS_URL=your_upstash_url
REDIS_TOKEN=your_redis_token

โœจ Features

๐Ÿ“ Create, edit, and delete diary entries

๐Ÿ” End-to-End Encryption (AES) with client-side passphrase

๐Ÿ“ง OTP Verification with Brevo

๐Ÿ“… Calendar-based entry filtering

๐ŸŒฅ๏ธ Weather Updates

๐Ÿ”ฎ Future Scope

๐ŸŒ Community Section

๐Ÿ“Š Better visulization of data

๐Ÿ“ค PDF export and backup to cloud storage

๐Ÿง  AI-based sentiment analysis of diary entries

โ›ณ๏ธ Live Preview

  • Azure VM + AIVEN DB (Jenkins Pipeline) - โ˜๏ธClick to Visit

About

Diary Website | Made with ๐Ÿ’–, React and Springboot

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors