Recumap

This project was build during Hacktic as a merge of this and this projects. During this Hackaton many Facttic coops have participated.

Objectives

• To provide social organizations with a simple tool to create and track family houses or other locations which may need special assistance.
• Facilitate the opportunity to offer donations to these organizations.
• Map and publish resources which may be of aid to the public during COVID-19 emergency.

Development requirements

Built using the Elixir's Phoenix Framework. To run this app you will need:

• Erlang OTP >= 18
• Elixir >= 1.5
• NodeJS >= 5.0
• PostgreSQL >= 11.5

Create a Database and Database User

By default, Postgres uses an authentication scheme called “peer authentication” for local connections. Basically, this means that if the user’s operating system username matches a valid Postgres username, that user can login with no further authentication.

During the Postgres installation, an operating system user named postgres was created to correspond to the postgres PostgreSQL administrative user. We need to change to this user to perform administrative tasks:

sudo su - postgres

You should now be in a shell session for the postgres user. Log into a Postgres session by typing:

psql

First, we will create a database for our Elixir project. Each project should have its own isolated database for security reasons. We will call our database recumap_dev.

CREATE DATABASE recumap_dev;

You can use the default postgres user provided by postgres or create a new one that has access to the previously created database. If you do so don't forget to update your .env file with thie new user.

CREATE USER recumap_user WITH PASSWORD 'recumap_user';

If you happen to have any trouble regarding unsufficient privileges, something you can do is give our database user access rights to the database we created:

GRANT ALL PRIVILEGES ON DATABASE recumap_dev TO recumap_user;

Exit the SQL prompt to get back to the postgres user’s shell session:

\q

Exit out of the postgres user’s shell session to get back to your regular user’s shell session:

exit

To start your Phoenix server using Makefile

Makefile gathers a list of useful commands.

• make server sources .env for environment variables and runs mix phx.server inside iex.

• make compile is an alias for mix compile.

• make release hasn't yet been implemented. Sets MIX_ENV to prod and runs mix commands required to create a release.

• make test hasn't yet been implemented. Sets MIX_ENV to test and runs tests.

• make dializer hasn't been implemented.

• make plt hasn't been implemented.

• make clean hasn't yet been implemented. Cleans and reinstalls deps and npm packages.

To start your Phoenix server using mix

• Install dependencies with mix deps.get
• Create and export env variables for your dev PostgreSQL configuration. E.g.: .env.example
• Create and migrate your database with mix ecto.setup
• Install Node.js dependencies with cd assets && npm install
• Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

API Endpoints

AUTH

• POST api/registration (Register user) Body Keys: user[email], user[password], user[password_confirmation]
• POST api/session (It returns a Token) Body Keys: user[email], user[password]

API (Should add Authorization header with token)

• GET api/orgs
• GET api/resources