/aashroy-api

The backend api for our Aashroy Project for JEC Hackathon 2021

Primary LanguageJavaScript

Aashroy - Decoding Apocalypse

A mapping system for the homeless people. A JEC Hackathon project. Made by the student of NIT, Silchar, Assam

Team Members

Screenshots:

Homepage

Home Page

Upload Location and Homeless Data page

Upload

Donate Money Portal

Donate Money

Donation of Foods, Medicines, Clothes

Donate Stuffs

Chatbot for Anonymous Reporting Facility

Report

Our Project Idea

The problem of homelessness has been a major issue in our country especially in Assam with about 1.7 billion homeless people in India and with the numbers still increasing exponentially.The problem of homelessness brings with it the hindrance of basic Human rights of proper living conditions and sanitation. These homeless people are further prone to crimes such as slavery, child trafficking, and crimes on women and children.Although a lot of projects have been undertaken by ths government agencies but the problem still persists without any permanent solution in our hand.So, here Our team of Decoding Apocalypse has tried our level best to find a solution and come up with innovative technology to tackle the problem at hand.

Objectives of Aashroy

Objective 1: To track the shelters of the homeless people through the web portal by inputs from the general public. Objective 2: To design a database of the homeless population with necessary fields. Objective 3: To provide the data to different NGOs & organizations working for upliftment of the homeless. Objective 4: To prevent crime and exploitation against this sector of people. An anonymous reporting mechanism for the users in the web application to report any crime or illegal activities against these people. Objective 5: To make the GUI interactive and to encourage voluntary donations (clothes/food/medicines) from the general public.

Running Locally

By following the instructions you can get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites 📄

Your local machine must have Git and Node.js (which basically comes with NPM) installed.


Let's see how to use? 🛠

Open your git bash in the required directory and first clone this repository-

# Clone this repository and the server repository
$ git clone https://github.com/decoding-apocalypse/aashroy-client.git
$ git clone https://github.com/decoding-apocalypse/aashroy-api.git

# First go into the server repository
$ cd aashroy-api

# Remove current origin repository
$ git remote remove origin

Then install the dependencies using NPM-

# Install dependencies
$ npm install

# Start development server
$ npm run dev
# Once your server has started, now go to the codachat repository:
$ cd aashroy-client
# Remove current origin repository
$ git remote remove origin

# Start the react app
$ npm start

Add the necessary environment variables as in .env.example.

Feel free to text any of the team members for any queries.

For contributing read CONTRIBUTING.md