vejovoce/shikoba-api

API for the Shikoba System

This is the Elixir and Phoenix backend API for the Shikoba Platform

Installation

Requirements

You will need to install the following:

• Elixir
• PostgreSQL

Clone this repository

You'll want to clone this repository with git clone [email protected]:vejovove/shikoba-api.git. If you plan on contributing, you'll want to fork it too!

To start your Phoenix server:

• Install dependencies with cd backend/ && mix deps.get and cd frontend/ && yarn install
• Configure database credentials: cp backend/config/dev.secret.example.exs backend/config/dev.secret.exs
• Create and migrate your database with cd backend/ && mix ecto.setup
• Start Phoenix endpoint with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Contributing

All contributions are more than welcome! PRs without tests won't be accepted.

Please, follow the guidelines

shikoba-api's Issues

Create locations

Description

Blocked by #1

Create locations table in locations context:

Notes

• Add a nullable reference for users table.

Tasks

• Create location migration.
• Create location Ecto schema.
• Add location as nested changeset in user schema (we can use cast_assoc
• Create location context with Crudry default functions
• Create GraphQL schema (just the schema)

Create NaturalPersons

Description

Blocked by #1

Create natural persons table in Accounts context:

Notes

• Add unique constraint to cpf field. We can use the unique_index function
• Possible values for gender -> male, female and non_binary. For enums, use EctoEnum
• Add unique constraint to user_id.

Tasks

• Create migration;
• Create Ecto schema in Accounts context;
• Create GraphQL schema (No mutations for now);
• Create factory;
• Create seeds;
• Create tests;

Implement Uploadex

Description

Add Upload to handle file uploads

Tasks

• Add Uploadex dependency
• Setup Minio integration for S3 object-storage server

Create users

Description

Add new fields to user schema.

Notes

User table:

• Possible roles: user and admin
  The NULL in field means the field could be null

• Save the phone number only with numbers

• We will not implement file upload for now, so the field photo can be a string. We can use the library Faker as a workaround. (docs here)

Tasks

• Add fields to user schema
• Create seeds (one normal user and one admin are enough for now)

Create NGOs

Description

Create NGOs table and context.

Notes

• Upload is not implemented yet. Use Faker as workaround in photo.
• Save cnpj with only numbers.
• Ignore location_id and social_network_id for now.

Tasks

• Create migration.
• Add NGO reference to locations table (a belongs_to association in location schema)
• Create NGO Ecto schema in NGO context. Use Crudry here
• Add location nested changeset in NGO changeset. Use cast_assoc like in #3
• Create NGO GraphQL schema with all basic queries and mutations.
• Create factory.
• Create seeds.
• Create tests.

Add NGO managers

Description

Blocked by #3

Create NGOs table and context.

Notes

• Upload is not implemented yet. Use Faker as workaround in photo.
• Save cnpj with only numbers.
• Ignore location_id and social_network_id for now.

Tasks

• Create migration.
• Add NGO reference to locations table (a belongs_to association in location schema)
• Create NGO Ecto schema in NGO context. Use Crudry here
• Add location nested changeset in NGO changeset. Use cast_assoc like in #3
• Create NGO GraphQL schema with all basic queries and mutations.
• Create factory.
• Create seeds.
• Create tests.

Improve README

• Change picture to be responsive on dark mode? Maybe using the prefers-color-scheme: dark in picture tag (see example here.
• Remove folder /backend from setup guidelines.