Sevelar / DisViewer

The React & Electron MD live-preview text editor, based on Discord UI design and formatting style.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool



Introducing: DisViewer! The live-preview text editor styled in fashioned Discord theme. This application utilizes frameworks like Electron.js and React.js. It shares a lot of functionality from its older predecessor, Discord Previewer.

This project is a direct successor to Discord Previewer. The old application will no longer receive any updates, while DisViewer will continue to be maintained and updated. Stay tuned for more updates.


This project uses Vite tooling for testing and building web applications.

⚙️ Install and Run

  1. Clone the repository via Git and install all required dependencies:
git clone https://github.com/Sevelar/DisViewer.git your-project-name
cd your-project-name
npm install
  1. Once it's done, run the attached scripts to get the application up and running:
npm dev
npm electron

These commands will start a development server and open a new Electron instance with the application ready to go.

🔧 Available Scripts

In the project directory, you can run:

npm dev

Runs the app in the development mode.
Go to http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any errors in the console.

⚠️ Disclaimer: Keep in mind that native Electron methods will be unavailable in the web browser.

npm electron

Opens the new Electron instance.
Once you run the application in development mode, you can use this script in order to create an Electron instance to debug your code.

Since this application was meant to be opened with Electron in mind, you'll need this script in order to successfully run the application.

Remaining Scripts

You can find the list of remaining scripts in the package.json file.

📝 Learn More

If you are interested in getting started with React and Electron, you should check out both React documentation and Electron documentation.

About

The React & Electron MD live-preview text editor, based on Discord UI design and formatting style.


Languages

Language:JavaScript 61.1%Language:CSS 34.9%Language:HTML 4.0%