Skip to content

README.md

Latest commit

 

History

History
186 lines (134 loc) · 3.53 KB

README.md

File metadata and controls

186 lines (134 loc) · 3.53 KB

🔐 Cipher-Web

Vite React TypeScript License

A modern, high-performance Text Encryption & Decryption Web Application with a futuristic UI and a secure backend.
Cipher-Web focuses on privacy, speed, and clean design, offering client-side encryption with a professional full-stack architecture.

🌐 Live Demo

✨ Features

  • 🔒 Secure text encryption & decryption
  • ⚡ Fast backend powered by Express & TypeScript
  • 🎨 Futuristic UI with smooth animations
  • 🌌 Cyber-themed background & effects
  • 🧠 Clean full-stack architecture
  • 🌐 Deployed with modern cloud platforms

🖼 Screenshots

🏠 Home Screen

Home Screenshot

🔐 Encryption Interface

Encryption Screenshot

🌌 Decryption Interface

Decryption Screenshot

🛠 Tech Stack

Frontend

  • React
  • Vite
  • Tailwind CSS
  • Framer Motion
  • TanStack Query

Backend

  • Node.js
  • Express
  • TypeScript

Tooling & Utilities

  • tsx
  • Vercel (Frontend hosting)
  • Render (Backend hosting)

📂 Project Structure

Cipher-Web/
├── client/ # Frontend (Vite + React)
│ ├── public/ # Static assets
│ ├── src/
│ │ ├── components/
│ │ ├── pages/
│ │ ├── lib/
│ │ └── styles/
│ └── index.html
│
├── server/ # Backend (Express + TS)
│ ├── routes/
│ ├── static.ts
│ └── index.ts
│
├── shared/ # Shared types / utilities
├── vite.config.ts
├── package.json
├── MIT.License
└── README.md

🚀 Getting Started (Local Development)

1️⃣ Clone the repository

git clone https://github.com/divyam007142/Cipher-Web.git
cd Cipher-Web

2️⃣ Install dependencies

npm install

3️⃣ Run backend + frontend (development)

npm run dev

🌍 Deployment Architecture

Browser
   ↓
Vercel (Frontend – Vite / React)
   ↓ API requests
Render (Backend – Express / TypeScript)

4️⃣ Open in browser

Backend runs on:

http://localhost:5000

If a frontend dev server is enabled:

http://localhost:5173

🧪 Available Scripts

Command Description
npm run dev Start development server
npm run build Build the project
npm start Run production server
npm run check TypeScript type checking

⚠️ Common Issues

Windows Error: 'NODE_ENV' is not recognized

✔️ Already fixed using cross-env No extra steps needed.

📌 Future Improvements

  • 🔐 Multiple encryption algorithms
  • 🌙 Dark / Light mode toggle
  • 📱 PWA support
  • 🔑 Password-based encryption
  • ☁️ Cloud save feature

🤝 Contributing

Contributions are welcome! Feel free to fork the repo and submit a pull request.

📄 License

This project is licensed under the MIT License.

👨‍💻 Author

Lunar Vibes

Building modern, secure, and clean web experiences.