๐ก๏ธ ยท BimeYaran React MySQL ยท
๐ 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:
๐ 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 portlocalhost: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 likeDataGrip
,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:
๐งฐ 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
โ๐ป Author
Mohammad Nedaei
๐ Contact
Discord: Mohammad81#3277