Welcome to iShelter

Hackathon Challenge to Build an App to help Ukrainian Refugees.

iShelter will fund temporary housing for up to 100,000 people fleeing Ukraine ❤, regardless of their nationality, racial or ethnic origin, or how they identify themselves. You can offer your space for this cause for free through iShelter, or make a donation that will help finance the stays of those who need it most.

Look our demo here!

(click on the image below to see the demo)

Front end to Back End request/response diagram:

Installation

Clone the Repository

git clone https://github.com/CodingDojoHackathonTeam2/SafeMaps.git
cd SafeMaps

FRONT-END

Technology	LINK
JavaScript	https://developer.mozilla.org/es/docs/Web/JavaScript
ReactJS	https://es.reactjs.org/
React Router DOM	https://www.npmjs.com/package/react-router-dom
Tailwind CSS	https://tailwindcss.com/
Radix UI	https://www.radix-ui.com/
Daisy UI	https://daisyui.com/
Axios	https://axios-http.com/docs/intro

1. Installation of libraries

npm install

2. Run the project

npm run dev

BACK-END

Technology	LINK
Python	https://docs.python.org/3/
Django	https://docs.djangoproject.com/en/4.0/
Django Rest Framework	https://www.django-rest-framework.org/
MapBox's APIs	https://docs.mapbox.com/api/overview/
PayPal APIs	https://developer.paypal.com/home
SqLite	https://www.sqlite.org/index.html

1. Create directory above repository

2. In direcory above repository create virtual environment

python3 -m venv envSafe

! If python3 doesn't work, may have to use python

Your directory tree should look like this:

3. Activate virtual environment (Windows)

envSafe/Scripts/activate

May have to use call

call envSafe/Scripts/activate

(Mac/Linux)

source envSafe/bin/activate

5. Install CORS Headers library

pip install django-cors-headers

6. installing django-cors-headers will install Django Version 4.0.0, but we're using 3.0.0. So you may have to uninstall Django

pip uninstall Django

4. install the rest of the packages

pip install Django==3.0.0 djangorestframework djangorestframework-simplejwt requests

Run server

1. Make Migrations and Migrate

python3 path/to/manage.py makemigrations

python3 path/to/manage.py migrate

2. Run django server

python3 path/to/manage.py runserver

Admin

1. Create superuser

python path/to/manage.py createsuperuser

2. Follow prompts
3. Test login at http://127.0.0.1:8000/admin/

Endpoints

Get CSRF Token

Method	URI
GET	api/csrf/

Check session

Method	URI
GET	session/check

Register

Method	URI
POST	api/users/register

User Login

Method	URI
POST*	api/users/login

Requires CSRF Token

New Announcement

Method	URI
POST	api/announcements/create

All Announcements

Method	URI
GET	api/announcements/all

Get all profiles

Method	URI
GET	api/v1/profiles

Get all profiles

Method	URI
GET	api/v1/profiles

IN THE NEX VERSION OF ISHELTER WE PROJECT OURSELVES TO:

• Clean up code
• Migrate from sqlite to a hosted db like Postgres or MySQL
• Allow hosts to upload pictures
• Have hosts and refugees list needed items for donors to send
• Contact or messaging feature from Refugee to Host
• Not a technology step, but hosts would submit applications and have a background check run

OUR TEAM

1. Lee Aarron - leeaarron (Github)
2. Stuart Yee - Stuart-Yee (Github)
3. René Caceres- caceresrene(Github)
4. Jhomar Astuyauri - Jhomar1158-ux (Github)
5. Lino Cruz - LinoCruz (Github)
6. Damian Cardenas- Mauffin (Github)