From 255c9a40758cd689d624edb8cefee360fd348201 Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 13:58:09 +0200 Subject: [PATCH 1/6] =?UTF-8?q?=F0=9F=96=8A=EF=B8=8F=20feat:=20readme=20re?= =?UTF-8?q?write=20and=20rebranding=20to=20kashafty?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e0d956b9..67fa75a4 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,38 @@ -# Scout Management System +# ![Logo](READMEImages/logo-ex.png) Kashafty -![Logo](READMEImages/logo-ex.png) +This is Kashafty! An SPA for managing all the scout groups needs. Attendance, finance, activities you name it! we got it! -## About the Project + -Scout management system is a website implemented using **PERN stack**. This project is a 2nd year CUFE project for practicing on the fundemental rules of database system management. + -![Landing Page](READMEImages/Landing%20Page%20Cropped.png) +## 🤔 But why? -## Our website is now on air🔥 +- Have you ever tried to record the attendance of over 500 person using only a paper and a pen? Well, we did and it was a mess! +- Have you ever to make reports on something and found yourself in the face of a huge pile of papers that is impossible to handle? guess what, we did too! +- as a leader, have you ever found yourself in a headache trying to manage the mess of data and reports that come from every direction with no clear structure? we totally understand you! -We deployed our website, although, it is still in progress so you might find some missing functoinalities. +So we made `Kashafty` the solution for all scout groups' problems. It is a website that helps you manage all your scouts' data, activities, finance and much more! -To login as a general captain use: + -> email: general@gmail.com -> pass: 1234 + -🔥[Website Link](https://scouts-managment-system-development.onrender.com/)🔥 + -## Why do you have to use this website? + + + +## 🚀 Quick start + +To get started navigate to [Kashafty demo](https://scouts-managment-system-development.onrender.com/) and use this account to try out the Main functionalities: + +> - email:[general@gmail.com](general@gmail.com) +> - pass: 1234 + +you can also create your own account and try out the system as a regular captain. + +## 📖 Documentation and features This website is based on a well structured database and a user friendly app, which helps in providing the best managerial experience to the scout captains. It helps them in: @@ -52,6 +65,19 @@ This website is based on a well structured database and a user friendly app, whi - Providing graphs for better analysis - Getting reports on the current system status +## Tech Stack + +- **Frontend:** + - ![React](https://img.icons8.com/ios/50/000000/react-native.png) React + - ![Redux](https://img.icons8.com/ios/50/000000/redux.png) Redux + - ![JavaScript](https://img.icons8.com/ios/50/000000/javascript.png) JavaScript + - ![Sass](https://img.icons8.com/windows/50/000000/sass.png) Sass +- **Backend:** + - ![Node.js](https://img.icons8.com/windows/50/000000/node-js.png) Node.js + - ![Express.js](https://img.icons8.com/ios/50/000000/express.png) Express +- **Database:** + - ![PostgreSQL](https://img.icons8.com/ios/50/000000/postgreesql.png) PostgreSQL + ## Pre-implementation phase ### Database design @@ -74,17 +100,22 @@ We have designed a complete UX design for all system pages: about 40 pages [User Stories](https://drive.google.com/file/d/1RwYU0OpM7EVVqLCTXDNxmlU7WgaKOdvz/view?usp=sharing) -## How to run? +## How to run locally? -run the following commands in the terminal +after filling the `.env` file as required. run the following commands in the terminal -``` +```bash npm i npm run dev ``` -## Contributers +## Contributors -| ![Abdelruhman](https://avatars.githubusercontent.com/u/121282837?v=4) | ![Amir](https://avatars.githubusercontent.com/u/88613195?v=4) | ![Akram](https://avatars.githubusercontent.com/u/109467185?v=4) | ![Ahmed](https://avatars.githubusercontent.com/u/104217693?v=4) | + + +| Abdelruhman | Amir | Akram | Ahmed | +| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| [AbdelruhmanSamy](https://github.com/AbdelruhmanSamy/) | [amir-kedis](https://github.com/amir-kedis/) | [akramhany](https://github.com/akramhany/) | [AhmedHamed3699](https://github.com/AhmedHamed3699) | From 73972e8a86ef0da439cdb95b324135efd762677a Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 13:59:15 +0200 Subject: [PATCH 2/6] =?UTF-8?q?=F0=9F=A7=B9=20chore:=20restore=20the=20rea?= =?UTF-8?q?dme=20image?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 67fa75a4..bb69a4bf 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ This is Kashafty! An SPA for managing all the scout groups needs. Attendance, fi - + +![Landing Page](READMEImages/Landing%20Page%20Cropped.png) ## 🤔 But why? From 7d4699d6d90fd008a66c237079283b8cc2814851 Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 14:06:05 +0200 Subject: [PATCH 3/6] =?UTF-8?q?=F0=9F=90=9B=20fix:=20some=20typos=20and=20?= =?UTF-8?q?misplaces?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bb69a4bf..c5c39b30 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,11 @@ This is Kashafty! An SPA for managing all the scout groups needs. Attendance, fi -![Landing Page](READMEImages/Landing%20Page%20Cropped.png) ## 🤔 But why? - Have you ever tried to record the attendance of over 500 person using only a paper and a pen? Well, we did and it was a mess! -- Have you ever to make reports on something and found yourself in the face of a huge pile of papers that is impossible to handle? guess what, we did too! +- Have you ever had to make reports on something and found yourself in the face of a huge pile of papers that is impossible to handle? guess what, we did too! - as a leader, have you ever found yourself in a headache trying to manage the mess of data and reports that come from every direction with no clear structure? we totally understand you! So we made `Kashafty` the solution for all scout groups' problems. It is a website that helps you manage all your scouts' data, activities, finance and much more! @@ -33,6 +32,8 @@ To get started navigate to [Kashafty demo](https://scouts-managment-system-devel you can also create your own account and try out the system as a regular captain. +![Landing Page](READMEImages/Landing%20Page%20Cropped.png) + ## 📖 Documentation and features This website is based on a well structured database and a user friendly app, which helps in providing the best managerial experience to the scout captains. It helps them in: @@ -66,18 +67,13 @@ This website is based on a well structured database and a user friendly app, whi - Providing graphs for better analysis - Getting reports on the current system status -## Tech Stack +## 🧰 Tech Stack + +- **Frontend** + -- **Frontend:** - - ![React](https://img.icons8.com/ios/50/000000/react-native.png) React - - ![Redux](https://img.icons8.com/ios/50/000000/redux.png) Redux - - ![JavaScript](https://img.icons8.com/ios/50/000000/javascript.png) JavaScript - - ![Sass](https://img.icons8.com/windows/50/000000/sass.png) Sass -- **Backend:** - - ![Node.js](https://img.icons8.com/windows/50/000000/node-js.png) Node.js - - ![Express.js](https://img.icons8.com/ios/50/000000/express.png) Express -- **Database:** - - ![PostgreSQL](https://img.icons8.com/ios/50/000000/postgreesql.png) PostgreSQL +- **Backend** + ## Pre-implementation phase @@ -117,6 +113,6 @@ npm run dev | [AbdelruhmanSamy](https://github.com/AbdelruhmanSamy/) | [amir-kedis](https://github.com/amir-kedis/) | [akramhany](https://github.com/akramhany/) | [AhmedHamed3699](https://github.com/AhmedHamed3699) | --> -| Abdelruhman | Amir | Akram | Ahmed | +| Abdelruhman | Amir | Akram | Ahmed | | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | [AbdelruhmanSamy](https://github.com/AbdelruhmanSamy/) | [amir-kedis](https://github.com/amir-kedis/) | [akramhany](https://github.com/akramhany/) | [AhmedHamed3699](https://github.com/AhmedHamed3699) | From ba7002c5e2ce969d4faba35e1dd5c68fa72d749b Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 14:08:55 +0200 Subject: [PATCH 4/6] =?UTF-8?q?=F0=9F=A7=B9=20chore:=20small=20formatting?= =?UTF-8?q?=20fix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c5c39b30..c4d02373 100644 --- a/README.md +++ b/README.md @@ -70,10 +70,12 @@ This website is based on a well structured database and a user friendly app, whi ## 🧰 Tech Stack - **Frontend** - + + - **Backend** - + + ## Pre-implementation phase @@ -114,5 +116,5 @@ npm run dev --> | Abdelruhman | Amir | Akram | Ahmed | -| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| [AbdelruhmanSamy](https://github.com/AbdelruhmanSamy/) | [amir-kedis](https://github.com/amir-kedis/) | [akramhany](https://github.com/akramhany/) | [AhmedHamed3699](https://github.com/AhmedHamed3699) | +| ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| [AbdelruhmanSamy](https://github.com/AbdelruhmanSamy/) | [amir-kedis](https://github.com/amir-kedis/) | [akramhany](https://github.com/akramhany/) | [AhmedHamed3699](https://github.com/AhmedHamed3699) | From 37d52240d137828e64f342b39abdf96b9df3724e Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 14:10:24 +0200 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=A7=B9=20chore:=20add=20figma=20to=20?= =?UTF-8?q?readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c4d02373..6cf4b25b 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ This website is based on a well structured database and a user friendly app, whi - **Frontend** - + - **Backend** From 67dd20044eb79f99a12a85227ca0e303762a0d78 Mon Sep 17 00:00:00 2001 From: amir-kedis Date: Fri, 26 Jan 2024 14:11:36 +0200 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=A7=B9=20chore:=20fancy=20description?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cf4b25b..f1890e19 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ![Logo](READMEImages/logo-ex.png) Kashafty -This is Kashafty! An SPA for managing all the scout groups needs. Attendance, finance, activities you name it! we got it! +This is Kashafty! An SPA for managing all the scout groups needs. Attendance, finance, activities you name it! we got it! 😉