🇺🇦🏡🇫🇷

Find-Shelter

This is an Open Source website aiming to gather contact informations about french people wanting to help ukrainians seeking shelter outside their country.
🐛 Report Bug · Request Feature 🌟

Table of Contents

1. About The Project
   • Context and Problem
   • Goal
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About The Project

Context and Problem

A war started between Russia and Ukraine on the 20th of February 2022.
This war led a massive amount of people to flee their country.
Many of them are coming to France to seek shelter.

Many french people have said on the radio, television and newspapers that they wanted to help and host ukrainian refugees. The only problem is that their contact information is not gathered yet.

Goal

The goal of this project is to gather contact informations about french people (and limited to them for now) wanting to help ukrainians seeking shelter outside their country.
Those informations will be passed on to associations and organizations that are in contact with refugees.

Built With

The front-end is built with VueJS and is hosted on Netlify

The back-end is built with NodeJS and is hosted on Heroku

Getting Started

Prerequisites

1. You will be using the Terminal so make sure you have one installed. (MacOS / Windows)

2. You will also need NodeJS installed on your computer. Install NodeJS.

3. You finally need to clone this repo with git. Install it.

Installation

1. Open your terminal and enter this command:

   cd ~/Desktop

2. Clone this repo with:

   git clone https://github.com/Find-shelter/find-shelter

3. Once cloned, you need to install the dependencies with:

   cd back && npm install && cd ../front && npm install

4. In your backend repo, create and edit a new file called .env with the following content (you can copy the existing .env.dist, rename it to .env and edit the variables inside):

   DB_URL=mongodb://127.0.0.1:27017/find-shelter
   CORS_ORIGIN=http://localhost:8080

5. [OPTIONAL]: If you don't already have a mongodb running for the back-end: n your backend repo, execute the following command:

   docker-compose up -d

6. In your frontend repo, create and edit a new file called .env.local with the following content (you can copy the existing .env.dist, rename it to .env and edit the variables inside):

   VUE_APP_API_HOST=http://localhost:3000
   

7. Open a separate terminal and enter this command:

   cd ~/Desktop/find-shelter/back && npm start

Usage

The use of this website is simple:

1. Once you followed the previous steps, you will be able to access the website by going to: http://localhost:8080
2. You'll be able to see the exact same things as the website.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Note that the project use i18n for Vue for multi-languages managment. Each language has it own JSON file in the front/src/locales folder (en.json for english, fr.json for french, etc.). If you want to add content, please follow this instructions :

1. Add you content in the locales JSON files (front/src/locales). Make sure you add the same structure of content in each JSON file, with the corresponding translation.
2. In the component where you want the content to appear, please use {{ $t('path.to.your.content.in.JSON.files') }}.

You can also join us on Discord if you want to communicate with us directly!

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Find-Shelter: contact@find-shelter.com
For any suggestions: suggestion@find-shelter.com

Contributors

Made with contributors-img.