Dial Editor is a Markdown editor built using Flutter and Riverpod.
MIT License
Dial Editor is a Markdown editor built using Flutter and Riverpod.
Warning: I am currently pursuing a master's degree and do not have much time for development at the moment. I intend to resume work on this personal project later on.
Warning: This project is in its early stages. Use it at your own risk.
Download and install Visual Studio Code from https://code.visualstudio.com/download.
Download and install Flutter SDK from https://docs.flutter.dev/get-started/install. Once you have the SDK, refer to https://flutter-ko.dev/get-started/install/windows for a comprehensive installation guide on setting up Flutter and Dart. You can find the official installation guide on the Flutter website.
Run flutter doctor in your terminal, once you have installed Flutter on your system, it will automatically check for the necessary system requirements to run the program. These requirements may include the Android toolchain, Chrome, Visual Studio, and Android Studio.
Download and install Chrome form https://www.google.com/chrome/browser-tools/. Chrome is the default web browser utilized by Flutter when running the app.
Download and install Visual Studio from https://visualstudio.microsoft.com/downloads/.
Download and install Android Studio from https://developer.android.com/studio.
To install Android toolchain, these steps need to be followed:
After installing all the required software and tools, run flutter doctor again to validate. Once you have done that, open a terminal and clone the project's Git repository using git clone https://github.com/zz0-0/dial_editor.git
git clone https://github.com/zz0-0/dial_editor.git
cd dial_editor
Use Visual Studio Code to open the project and then run in the terminal: flutter pub get, to get all the required flutter packages.
flutter pub get
To run the app, you can navigate to the main.dart file located under the lib directory. There are two methods to run the app. First, you can go to the bottom right corner of Visual Studio Code, click on No device and select Start Flutter Emulator. Then, locate the button group of Run, Debug, and Profile just above the main method. Clicking on Run will run the app. Alternatively, you can still be on the main.dart file and go to the top right corner of Visual Studio Code, where you'll find a button labeled Start Debugging. Click on the dropdown and select Run without Debugging.
flutter run
or
Locate the button group of Run, Debug, and Profile just above the main method. Clicking on Run will run the app.
Once the Android emulator has launched and the app is running, you can either open an existing folder or create a new one within the app. After that, you will be able to create a new markdown file or open an existing one for editing. I have included a markdown file for you, which you can simply drag into the download folder for testing.
On Desktop, you can either open an existing folder or create a new one within the app which includes markdown file.
Inside the markdown file, begin writing in markdown syntax.
Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines.
git checkout -b feature/your_feature
).git commit -m 'Add some feature'
).git push origin feature/your_feature
).This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to reach out via email for any questions or feedback.