diff --git a/README.md b/README.md index 099638edd..0e1c7508d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ -## About +## πŸ“– About **PeakofEloquence** is an open-source Islamic education platform developed with modern web technologies to offer a rich and engaging learning experience in Islamic studies. Built using Nuxt, Tailwind CSS, and TypeScript, the platform includes interactive lessons, texts, and multimedia content. PeakofEloquence aims to make high-quality Islamic educational resources accessible to everyone. -[peakofeloquence.org](https://peakofeloquence.org/) +🌐 [peakofeloquence.org](https://peakofeloquence.org/) -## Technologies Used -- **Frontend**: Nuxt.js, Tailwind CSS, TypeScript -- **Backend**: Node.js, Express.js -- **Database**: MongoDB -- **Other Tools**: Vercel (deployment), Jest (testing) +## πŸ›  Technologies Used +- **Frontend**: Nuxt.js, Tailwind CSS, TypeScript +- **Backend**: Node.js, Express.js +- **Database**: MongoDB +- **Other Tools**: Vercel (deployment), Jest (testing) + +## πŸš€ Getting Started -## Getting Started To get started with PeakofEloquence, follow these steps: + 1. **Clone the repository**: ```bash git clone https://github.com/yourusername/peakofeloquence.git @@ -31,7 +33,7 @@ To get started with PeakofEloquence, follow these steps: --- -## Community and Contributions +## 🌟 Community and Contributions PeakofEloquence was created for the community. Contributions are welcome both in development and in the form of donations to help keep the site running and support further development. Planned features include voice integration, AI-powered interactions, and more. @@ -39,37 +41,41 @@ If you want to contribute, please check out our [contribution guidelines](#). If [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P3X2SN5) +--- + +## πŸ“œ License -License This project is licensed under the [License Name] - see the [LICENSE file](link to license file) for details. -Contact -For any queries or support, feel free to reach out to me @ [admin@rezajafar.com](mailto:admin@rezajafar.com.) +## βœ‰οΈ Contact + +For any queries or support, feel free to reach out to me at [admin@rezajafar.com](mailto:admin@rezajafar.com). --- -## Sources +## πŸ“š Sources This README.md file provides a list of sources for further reading on various topics related to Islam and related subjects. ### Books -- [Al-Islam.org](https://www.al-islam.org/book/export) -- [Nahjul Balagah Revisited: Introducing Imam β€˜Ali Ibn Abu Talib](https://www.al-islam.org/nahjul-balagah-revisited-introducing-imam-ali-ibn-abu-talib-asgharali-m-m-jaffer) -- [Nahjul Balagha Part 2, Letters and Sayings](https://www.al-islam.org/nahjul-balagha-part-2-letters-and-sayings) -- [Nahjul Balaghah - Juzuu ya Kwanza](https://www.al-islam.org/node/24794) -- [Nahjul Balaghah - Juzuu ya Pili](https://www.al-islam.org/node/24854) -- [The Authenticity of Nahjul Balaghah](https://www.al-islam.org/articles/authenticity-nahjul-balaghah-sayyid-fadhil-milani) -- [The Commentaries on Nahjul Balaghah](https://www.al-islam.org/articles/commentaries-nahjul-balaghah-sayyid-wahid-akhtar) -- [The Concept of Freedom in the Nahjul Balaghah](https://www.al-islam.org/articles/concept-freedom-nahjul-balaghah-sayyid-wahid-akhtar) -- [The Contents of Nahjul Balaghah](https://www.al-islam.org/articles/contents-nahjul-balaghah-sayyid-wahid-akhtar) -- [The Emphasis on Justice in Nahjul Balaghah](https://www.al-islam.org/message-thaqalayn/vol-15-no-2-summer-2014/emphasis-justice-nahjul-balaghah-jafar-shahidi) -- [What is True Success? Excerpts from Peak of Eloquence (Nahjul Balagha)](https://www.al-islam.org/what-true-success-excerpts-peak-eloquence-nahjul-balagha) -- [Books on Islam, Muslims, Prophet Muhammad(s), Ahlul Bayt](https://www.al-islam.org/) +- πŸ“– [Al-Islam.org](https://www.al-islam.org/book/export) +- πŸ“– [Nahjul Balagah Revisited: Introducing Imam β€˜Ali Ibn Abu Talib](https://www.al-islam.org/nahjul-balagah-revisited-introducing-imam-ali-ibn-abu-talib-asgharali-m-m-jaffer) +- πŸ“– [Nahjul Balagha Part 2, Letters and Sayings](https://www.al-islam.org/nahjul-balagha-part-2-letters-and-sayings) +- πŸ“– [Nahjul Balaghah - Juzuu ya Kwanza](https://www.al-islam.org/node/24794) +- πŸ“– [Nahjul Balaghah - Juzuu ya Pili](https://www.al-islam.org/node/24854) +- πŸ“– [The Authenticity of Nahjul Balaghah](https://www.al-islam.org/articles/authenticity-nahjul-balaghah-sayyid-fadhil-milani) +- πŸ“– [The Commentaries on Nahjul Balaghah](https://www.al-islam.org/articles/commentaries-nahjul-balaghah-sayyid-wahid-akhtar) +- πŸ“– [The Concept of Freedom in the Nahjul Balaghah](https://www.al-islam.org/articles/concept-freedom-nahjul-balaghah-sayyid-wahid-akhtar) +- πŸ“– [The Contents of Nahjul Balaghah](https://www.al-islam.org/articles/contents-nahjul-balaghah-sayyid-wahid-akhtar) +- πŸ“– [The Emphasis on Justice in Nahjul Balaghah](https://www.al-islam.org/message-thaqalayn/vol-15-no-2-summer-2014/emphasis-justice-nahjul-balaghah-jafar-shahidi) +- πŸ“– [What is True Success? Excerpts from Peak of Eloquence (Nahjul Balagha)](https://www.al-islam.org/what-true-success-excerpts-peak-eloquence-nahjul-balagha) +- πŸ“– [Books on Islam, Muslims, Prophet Muhammad(s), Ahlul Bayt](https://www.al-islam.org/) -## Other Sources +### Other Sources -- [brill.com/flyer/title/69007?print=pdf&pdfGenerator=headless_chrome](https://brill.com/flyer/title/69007?print=pdf&pdfGenerator=headless_chrome) +- πŸ“ [brill.com/flyer/title/69007?print=pdf&pdfGenerator=headless_chrome](https://brill.com/flyer/title/69007?print=pdf&pdfGenerator=headless_chrome) --- +Feel free to ask if you need further customization! 🌟