/BimeYaran-React-MySQL

🛡️BimeYaran is an insurance solution created with React & MySQL

Primary LanguageTypeScriptMIT LicenseMIT

🛡️ · BimeYaran React MySQL ·

GitHub license PRs Welcome

🔎 Overview

BimeYaran-React-MySQL is a refreshed reboot and clone of Bime Iran. Front-End is created with React and modern UI libraries. There is a dashboard for users, admins, managers and owner with different access grants. Back-End is working with a NodeJS server connected to a MySQL database.

This app looks like this:

Screenshots may change in the future because of UI/UX changes.

🖥️ Desktop view:

home Screenshot from 2023-07-10 14-58-12 Screenshot from 2023-07-10 14-58-18 Screenshot from 2023-07-10 14-58-21 Screenshot from 2023-07-10 14-58-24 Screenshot from 2023-07-10 15-04-05 Screenshot from 2023-07-10 15-00-22 Screenshot from 2023-07-10 15-03-51 Screenshot from 2023-07-10 15-03-19 Screenshot from 2023-07-10 15-01-08

👁 Scenarios

🧾 React app is located in client directory. React app will run on localhost:5173 with vite which makes it completely separated from Back-End.
🧾 Back-End server runs on localhost:3001.
🧾 A MySQL server must be running on localhost:3306 which is default MySQL server.
🧾 Users can sign up or login to dashboard, but they are not treated as Clients until they order an insurance package and pass extra information about themselves.
🧾 Insurance packages in BimeYaran are: Health, Vehicle, Fire.
🧾 Clients can request a repay for an active insurance. repays must be accepted by admins or managers.
🧾 Contract is an activated insurance package that is valid to a date and has a Transaction.
🧾 Each insurance contract will insert into its own unique table.
🧾 Each insurance contract and Employee has a unique branch ID.

🚀 Usage

Run this commands in respectively in your terminal. \

  • Make sure that a MySQL service is running on port localhost:3306
  • Run this code in your terminal and enter password for MySQL user (default is root):
 mysql -u root -p
 
 CREATE DATABASE bime_yaran;

 quit
 git clone https://github.com/mohammadnedaei/BimeYaran-React-MySQL.git

 cd BimeYaran-React-MySQL &&  cd server &&  npm i && nodemon ./index.js 
  • Open new terminal in repository folder and run:
 cd client && npm i & npm run dev
  • Run bime_yaran.sql SQL dump file with any DB manager like DataGrip, MySQL management, HeidiSQL, phpMyAdmin or etc...
  • Or you can simply run this code block in MySQL terminal:
use bime_yaran;

source path_to_sql_file.sql;

Database Diagram Looks like this:

bime_yaran

🧰 Libraries and Tools

✅ Tailwind UI
✅ Material UI

  • Material icons

✅ Axios
✅ React Router
✅ React Hooks
✅ MySQL Database ✅ Normalized Database (3NF) ✅ Foreign Keys and Primary Keys Specified ✅ Based on true and online website (Bime Iran)

🔧 Contributing

Feel free to fork this repo and make pull requests. You can learn more about React here

🎯 TODO

🚧 Code factor & code quality tools improvements
🔃 Add Shortcuts in manifest \

💚 Support

Sociabuzz

✍🏻 Author

 Mohammad Nedaei

📞 Contact

Discord: Mohammad81#3277