Skip to content

Latest commit

 

History

History
272 lines (156 loc) · 9.64 KB

README.md

File metadata and controls

272 lines (156 loc) · 9.64 KB
Raw

tillsammans

Organising assistance for self-isolated risk groups of corona/covid-19

Uses React.js/Node.js, Firebase for deployment

Find the latest live version at:

https://tjorn.allatillsammans.se

Cloning this project - use it for your own community

We warmly welcome anyone who wants to clone this project for use in their own context.

What it is

It is in essence a simple platform for organisation of help efforts in a smaller community (a couple thousand at most). It focuses on:

  1. Registering needs from self-isolated risk groups - mostly errands. This so these groups do not have to break quarantine and expose themselves to unnecessary contamination risks
  2. Registering volunteers willing to help out with those needs
  3. Sharing information on local volunteergroups organised through the platform

It also includes an administration section where:

  1. A coordinator manages and distributes incoming needs and volunteers
  2. Group leaders on their separate group pages manage specific orders and volunteers

...this is what we are using it for at the moment. But as it in its core is a logistics platform for distributing needs to volunteer groups it can be applied to other situations as well.

It is built to be simple to use, and easy to manage even for people with a non-technical background.

How it works

  1. User registers an order or register to be a volunteer
  2. Email notification goes to the Coordinator
  3. Coordinator goes to admin section and assigns the order/volunteer to a group
  4. Coordinator generates an email to the user and to the group, confirming receipt and assignment
  5. Group leader goes to their group page and take action on order/volunteer (if order: assigns to a volunteer, if volunteer: sets up time for training)
  6. When completed/trained, group leader marks status of order as completed/volunteer as active in the system
  7. Coordinator follows updated status of order/volunteer, if not eventually marked as completed/active they follow up with the group leader

What you'll need

We strongly suggest conencting with existing networks in your local community who already have experience with helping out risk groups. So start by asking around and see if they want to join the effort and start a group on the platform. We are currently collaborating with the Tjörn municipality, the Swedish church, the Red Cross, Lions Club, Save the Children and other local actors. Having their knowledge and experience on board has been invaluable.

We use a group leader from one of our partners for each group, and new volunteers get assigned to their groups. That said, it is also possible to start volunteer groups from scratch by simply joining together those willing and assigning a group leader among them.

If you want to set up a similar structure to the one we have implemented you'll need:

  1. A coordinator: Receives and distributes incoming orders and volunteers to groups. Also handles orders thorough phone.
  2. Group leaders and reserve group leaders for each group: Manages volunteers and implements incoming orders
  3. A developer: Implements the original setup and adjustments of the code to your local context.
  4. A GDPR representative who oversees the handling of data

For the original setup, we will happily help out. If you don't have a developer we can also facilitate finding one. Welcome to contact me at asaisacson@gmail.com

Development

These instructions will get you a copy of the project up and running on your local machine for development purposes.

Once your changes are merged (see 'Working' and 'Building' section below) you and everyone else will see them live at https://tjorn.allatillsammans.se (or the url of your own site obviously, if you're cloning this project)

Tools

If this is your first rodeo, here's the from scratch setup you'll need:

  1. Code editor: Download visual studio from here https://code.visualstudio.com/ - this will let you add html and styles.
  2. Terminal: Download iTerm from https://iterm2.com/ - this will let you install the project and add any extras (if needed).
  3. A GitHub account: https://github.com/ - this will let you clone a copy of the project to your own machine, and also let you push changes to the central repository, which will then be merged into the live version at https://tjorn.allatillsammans.se

Prerequisites

You'll need to install Git and Node.js on your machine to get crackin.

Open your terminal.

First check if you have all the prerequisites and that they are good and well, write:

git --version
node --version
npm --version

...if the above gets any errors then fix them through the relevant solution below:

Git - for version control

git --version

...if you don’t have git installed already, this will prompt you to install it.

Node.js

brew install node

Original setup - get the latest code for the website

This you only need to do once, when you're first starting to work on the project. After that, you'll have a folder with the code on your computer and will keep it up to date through the 'pull' commands given in the 'Working' section. Don't worry about it now.

  1. Go to https://github.com/osaisacson/tillsammans

  2. Clone the project. On your own machine in the terminal window write:

ls

...to see where you are in the folder structure, and then


cd (the name of the folder which you want to place yourself in)

...usually it'll be something like:


cd Documents
cd CODE (this should be the name of the folder where you want to keep the code of the project on your own machine. It doesn't really matter where, just a place where you can find it easily.)

once you stand in the folder where you want to place the project, clone the existing tillsammans folder like this:


git clone https://github.com/osaisacson/tillsammans.git

...this will create a 'tillsammans' folder with latest code from GitHub. Yay. Done.

  1. Initialize git.

cd tillsammans
git init

Your code is now tracked in a local git repository. It has not yet been pushed to any remote servers, so changes you make in the code now will not yet show anywhere apart from on your own machine. You'll push the code to the remote shared repository in the 'Working' section.

  1. Install npm's.

Npm's are little external code packages that each contain something useful for a website. By doing the commands below you make sure you install these on your machine as external dependencies so your code can run.


cd tillsammans
npm install

Done with the installation! Now lets DO this.

Working

You'll be making changes on your local machine and checking them in your browser. Once you're happy you'll make a 'pull request' (sending your local code) to GitHub, where it will get merged into the main project and be made visible to all. GitHub works in a way that lets you push your changes in a separate branch to a main branch, much like track changes in a Word document.

This is how you create a separate branch, add changes to it and then request to have your changes integrated into the master branch:

  1. Check that you've got the latest version of the remote master branch (always do this. muy importante. If you don't first pull down the latest version of master then you'll be making a new branch off of old code, and get pesky merge conflicts), and then create a new branch of master:

git checkout master (moves you to the git master branch of the project)
git pull (pulls down the remote latest code of the project)
git checkout -b name-of-your-new-branch (creates a new branch identical to the latest code)

  1. Open your code editor. With your mouse drag the folder 'tillsammans' to the visual studio code editor icon.

  2. See your code: In your terminal, open a separate window (cmd + d), then:


cd tillsammans (ls and cd .. until you're in the tillsammans folder)
npm start (this opens up a http://localhost:3000 window in your browser)

``

4. Make changes to the code in visual studio code.

5. Once you're done with your changes to the code, push them to GitHub like this:

git add . git commit -m "commit message" git push (you'll be prompted to set the upstream branch, use the given suggestion) (repeat above until happy), then: go to https://github.com/osaisacson/tillsammans and make a PR (just press the pretty obvious button called 'Compare & pull request') doublecheck that it is from your branch to the master branch


Done! Let someone know that you've done changes that they can merge, or do the merge yourself (see steps in the 'Building' section below).

### Code review

This is for the person who will be approving that the changes you made above should indeed be merged into the main project. Best practice is that someone other than you merge it. Four eyes are better than two.

1. Go to https://github.com/osaisacson/tillsammans

2. Approve an existing PR (you'll see them clearly when you go to the above page, if there are any) and merge it to the master branch (press the 'merge' button...)

### Deploying

We are set up to deploy through firebase. If you are setting up a clone of Alla Tillsammans then this is how to do it from scratch: https://www.geeksforgeeks.org/hosting-a-static-website-on-firebase-for-free/

After that is set up this is what you do to release the changes:

1. Go to the master branch

npm run build

firebase deploy


Check out the changes at:

https://tjorn.allatillsammans.se


## Useful commands

Check your git branches, and see which one you're currently in.

git branch


Check your git settings so all looks well.

git config --list


## Author

- **Osa Gambas Isacson**

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details