Skip to content

Latest commit

 

History

History
153 lines (96 loc) · 6.5 KB

README.md

File metadata and controls

153 lines (96 loc) · 6.5 KB
Raw

Logo Kashafty

This is Kashafty! An SPA for managing all the scout groups needs. Attendance, finance, activities you name it! we got it! 😉

🤔 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 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!

🚀 Quick start

To get started navigate to Kashafty demo and use this account to try out the Main functionalities:

you can also create your own account and try out the system as a regular captain.

Landing Page

📖 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:

Scout management

  • Getting Scouts' absence and statistics over a certain interval
  • Sending automatic notifications in case of exceeding the limit of absence
  • Adding/removing them from/to any sector

Sectors management

  • Adding/removing new sectors from/to the system
  • Managing leading captains
  • Managing Absence for each sector's leading captains

Activities and sessions

  • Saving each activity including it's type, place and time
  • Grading scouts on the activities they joined and showing stats

Finance management

  • Adding weekly subscriptions
  • Adding incomes and expenses to the system
  • Getting updated value of the total balance and each transaction has been done

Stats

  • Viewing attendance stats for scouts and captains
  • Providing graphs for better analysis
  • Getting reports on the current system status

🧰 Tech Stack

  • Frontend

  • Backend

Pre-implementation phase

Database design

ER-design and schema designs for the database

ER

Schema

Figma Design

We have designed a complete UX design for all system pages: about 40 pages

Figma Design

View full figma design

User Stories

User Stories

How to run locally?

Note

you need to have docker and docker-compose installed on your machine

  1. clone the repo
git clone <repo-url>
cd kashafty
  1. create a .env in the root of the repo and fill the following variables
DB_USER=
DB_PASSWORD=
DB_NAME=kashafty
API_URL=http://localhost:5000
FRONTEND_URL=http://localhost:3000
JWT_SECRET=
JWT_EXPIRES_IN='60d'
NODE_ENV=development
PORT=5000
  1. run the following command
docker-compose up
  1. create the db doing the following
docker exec -it kashafty_backend_1 sh
npm run create-db
npm run seed-db
  1. open your browser and navigate to http://localhost:3000

Contributors

Abdelruhman Amir Akram Ahmed
AbdelruhmanSamy amir-kedis akramhany AhmedHamed3699