Skip to content

igmizo/echo

Repository files navigation

ECHO

Where markdown meets its reflection. A modern, real-time markdown editor and sharing platform built with Next.js 15.

Live Demo

ECHO Preview

Features

  • ✨ Real-time markdown preview
  • 🔗 Instant sharing with unique URLs
  • 🎨 Beautiful, responsive design
  • 🌙 Dark mode support
  • ⚡️ Built with performance in mind

Tech Stack

Getting Started

Prerequisites

  • Node.js 20.0 or later
  • npm or yarn
  • Redis database (you can use Upstash for free)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/echo.git
cd echo
  1. Install dependencies:
npm install
# or
yarn install
  1. Create a .env.local file in the root directory and add your Redis URL:
REDIS_URL="your-redis-url-here"
  1. Run the development server:
npm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser.

Deployment

The easiest way to deploy ECHO is using Vercel:

Deploy with Vercel

Don't forget to add your REDIS_URL to your Vercel environment variables.

Local Development

To run the project locally:

# Install dependencies
npm install

# Run development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments


Made with ❤️ by Ivars Gmizo

About

Modern markdown editor and sharing platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors