/Team4-CodeToGive

Our solution for the Bal Asha Trust Organization aiming to provide a digital platform to ease out their process of making children legally available for Adoption.

Primary LanguageJavaScript

Kare4Kids

Kare4Kids]

GitHub code size in bytes Languages

Table of Contents

- Introduction 
- Why?
- Tech Stack
- User Interface
- Setup Guide
- Available Scripts
- Contribution Guidelines

💛 Introduction

Kare4Kids is in the process of developing a comprehensive website that will feature separate login portals for two crucial roles: Social Workers and the Management team.

📌 This platform aims to facilitate seamless collaboration and efficient operations within the organization.

📌 The Social Worker login provides a dedicated space for members to fill in essential details about children and carry out the necessary processes to make them available for adoption.

📌 Meanwhile, the Management team, consisting of the Case Management and Operation Management teams, assumes the responsibility of overseeing and coordinating the entire adoption process.

📌 The Case Management Team will utilize their designated login to effectively manage the tasks assigned to Social Workers and ensure that they performs their duties to the highest standards.

📌 Additionally, the Operation Management team will closely monitor the execution of tasks by both the Case Management team and Social Workers, ensuring that all operations are carried out smoothly and efficiently.

Through this website, Kare4Kids aims to streamline the adoption process and provide optimal support for both Social Workers and the Management team, ultimately benefiting the children in their care.

💡 Why?

By combining our empathy, passion, research, collaborative discussions, and inspiration from existing initiatives, we were able to conceptualize and develop a comprehensive approach to child donation and support. Our goal is to provide a platform that empowers individuals to make a difference and ensure that every child has access to love, care, and opportunities for a brighter future.

Learn more about our idea here : https://www.youtube.com/watch?v=k_UCqAfqIA4&t=2s

📍 Tech Stack

React Django Flutter

📷 User Interface

Landing Page Form page
In Progress Page Assigning Cases Page
Child's Profile Page Management Profile Page

🔨 Setup Guide

To start with setting up the Local Project Environment:

- git clone https://github.com/tanyaarora2/Team4-CodeToGive.git
- cd Team4-CodeToGive
-- Start Django server
- cd backend
- python manage.py makemigrations
- python manage.py migrate
- python manage.py runserver
-- Start React server
- cd Frontend
- npm install
- npm start
- go to http://localhost:3000/ and get started

💻 Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

🤝 Contribution Guidelines

Kindly follow the below guidelines if you wish to contribute to the project:

  1. Fork this repository and clone it
git clone https://github.com/tanyaarora2/Team4-CodeToGive.git
  1. Add a reference(remote) to the original repository
git remote add upstream https://github.com/tanyaarora2/Team4-CodeToGive.git
  1. Check the remotes for this repository
git remote -v
  1. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository)
git pull upstream main
  1. Create a new branch
git checkout -b <your_branch_name>
  1. Perfom desired changes to the code base and track your changes
git add .
git status
  1. Commit your changes
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo
git push -u origin <your_branch_name>
  1. To create a pull request, click on compare and pull requests

  2. Add appropriate title and description to your pull request explaining your changes. Click on Create Pull Request