Arabic Reshaper App (ARA)

Reconstruct Arabic sentences to be used in applications which doesn't support Arabic
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements
9. TODO

About The Project

Arabic Reshaper هو موقع يسمح بتحويل الكتابة العربية الى كتابة مفهومة من قبل اغلب برامج التصميم مثل Photoshop و After Effects و Premiere Pro و Avid Media Composer و برامج اخرى كثيرة

Built With

• React
• Material UI
• arabic-persian-reshaper

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Git
• Node.js
• Visual Studio Code (Optional but highly recommended)

The project is built with Vite.

Installation

1. Clone the repo

   git clone https://github.com/bilalix/arabic-reshaper-app.git

2. Install NPM packages

   npm install

3. Runs the app in the development mode.

   npm start

   Open http://localhost:5173 to view it in the browser.
   The page will reload if you make edits, you will also see any lint errors in the console.

• Runs the test suite.

  npm test

  To run tests in watch mode, use:

  npm run test:watch

• Builds the app for production to the dist folder.

  npm run build

  It correctly bundles React in production mode and optimizes the build for the best performance.
  The build is minified and the filenames include the hashes and the app is ready to be deployed!

Learn More

You can learn more in the Vite documentation.

To learn React, check out the React documentation.

Usage

As shown in the screenshot above, you can type the Arabic text in the first text box area and copy the reshaped text that appears in the text box area below (as simple as that!)

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
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

Distributed under the MIT License. See LICENSE for more information.

Contact

Bilal El Houdaigui - bilal.elhoudaigui@gmail.com

Project Link: https://github.com/bilalix/arabic-reshaper-app

Acknowledgements

• The React team and the guys who made and maitaining Material UI.
• Many thanks to Shen Yiming (@soimy) and (@JesseDrain) for providing the arabic-persian-reshaper module.
• Best-README-Template: This guys are awesome!
• GitHub Emoji Cheat Sheet and [https://gist.github.com/parmentf/035de27d6ed1dce0b36a](Git Commit message Emoji) :simple_smile:

TODO

• ✨ Features:

  • Add Material UI and Arabic font (Tajawal)
  • Reshap Arabic text while typing (live reshap)
  • Add Dark Theme
  • Add 'copy to clipboard'
    • See this one or this one looks future-proof(er)
  • Switch between English and Arabic

• 🚀 Deployment:

  • Deploy the app
  • Add Docker
  • Add tests
  • Mirror to gitlab and add CI

• 📚 Documentation

  • Edit ReadMe
  • Add 'How it works' page

• 🐛 Bug fix

  • Fix Tajawal font
  • Fix Theme (see Issues)