hekayti-laravel

Laravel web panel for a playful educational app, enhancing children's reading and listening skills in a fun way.

📝 Table of Contents

• About
• Screenshots
• Built Using
• Getting Started
• Prerequisites
• Clone the Repository
• Install Dependencies
• Environment Setup
• Database Configuration
• Storage Configuration
• Running the Project
• API Reference
• Troubleshooting
• Contributing
• License
• Authors
• Acknowledgments

🧐 About

hekatyi_laravel: is a backend system designed to be a content management application for stories. It is used in a mobile application called "hekatyi" (My stroy in Arabic).

The management structure is divided into two roles:

• main administrator: who controls everything in the application, including publishing stories and managing sub-managers, and view statics of the growth of users in mobile app.

• sub-manager: who is responsible for managing the stories and their content, such as images, sounds, and text.

Additionally, users of the application can also edit their personal information.

📷 Screenshots

Here are some screenshots of the project:

Login Page:

Story Page:

slide Page:

Admin Page:

Home Page:

Profile Page:

⛏️ Built Using

• 
• 
• 
• 

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

⚙️ Prerequisites

Before you begin, ensure you have the following:

• PHP: Make sure you have PHP installed on your system. You can download it from the official PHP website.

• Composer: Composer is a dependency management tool for PHP. You can install it by following the instructions here.

• MySQL: This project requires a MySQL database. You can download and install it from the official MySQL website.

• Git: You'll need Git to clone the repository. Download and install it from the official Git website.

• Laravel Requirements: Make sure your system meets the Laravel server requirements.

📂 Clone the Repository

Open your terminal/command prompt and run the following command to clone the repository:

git clone https://github.com/MohammedShwabi/hekayti-laravel.git

🚀 Install Dependencies

1. Navigate to the project directory:

cd hekayti-laravel

2. Install project dependencies:

composer install

💻 Environment Setup

1. Copy the .env.example file and create a .env file:

cp .env.example .env

2. Generate the application key:

php artisan key:generate

💾 Database Configuration

1. Open the .env file and configure the database settings:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=hekayti
DB_USERNAME=your_database_username
DB_PASSWORD=your_database_password

3. Create the database:

php artisan migrate --seed

📁 Storage Configuration

Laravel uses storage for various purposes, including storing uploaded files, cached files, and more.

Follow these steps to configure the storage:

1. copy the contents of the 'images' folder to the 'storage/app' directory:

cp -R images/* storage/app/

2. Create symbolic links for storage:

php artisan storage:link

🚀 Running the Project

1. Start the development server:

php artisan serve

The project should now be accessible in your browser at http://localhost:8000.

2. enter the following credential to login to the web panel:

email: admin@example.com
password: adminpassword

📱 API Reference

This project includes an API that can be used with a Mobile app.

To access the Postman collection and API documentation, navigate to the HekaytiApiDocumentationAndCollection folder:

• Hekayti-Api-Documentation.xlsx
• Hekayti-Api.postman_collection.json

⚠️ Troubleshooting

If you encounter any issues during the setup process, refer to the Laravel documentation or search for solutions on Stack Overflow.

🙌 Contributing

If you'd like to contribute to the project, feel free to submit pull requests.

📜 License

This project is licensed under the MIT License.

✍️ Authors

• @MohammedShwabi Backend Development
• @HeshamNoaman Frontend Development

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• @MaryamHajeb for analysis, database design, and story creation.
• @almomyz for contributing ideas, dedication in the work, and developing the mobile app.
• @osama-nasser1999 for contributing ideas and participating in the development of the mobile app.