elixircl / cars

A simple cars api and frontend made with Elixir and Phoenix

Elixir Chile 🇨🇱

Elixir Chile 🇨🇱 tiene el objetivo de crear artefactos de software, documentación y actividades para el fomento de la tecnología Elixir en el país.

Comunidad

Github

Nuestros Repositorios.

Discord

Unirse a Discord de Elixir Chile.

Telegram

También disponible por si prefieres Telegram.

Github Wiki

La Wiki sirve para compartir pequeños snippets de códigos, como también tutoriales y otros tips.

Eventos

Los eventos, meetups y otros relacionados estarán en un tablero de proyectos de Github para su fácil organización.

cars's Issues

[feat] Create HTML Fontend

Create a simple HTML Frontend using the Base HTML
from

https://github.com/tailwindtoolbox/Nordic-Store

[feat] Add Database Tables

Create tables that store the following car data.

Schema: https://www.dbml.org/home/

Table makers {
  id int [pk, increment]
  name varchar(100)
  inserted_at timestamp
  updated_at timestamp
}

Table cars {
  id int [pk, increment]
  maker int [ref: > makers.id] // # one maker -> * cars
  model varchar(100)
  about varchar(100)
  image_url varchar
  inserted_at timestamp
  updated_at timestamp
}

[docs] project explanation and tech stack

About

This is a simple project that will showcase information about cars using separated backend and frontend.

Backend Technologies

• Elixir: https://elixir-lang.org/
• Phoenix: https://www.phoenixframework.org/
• Absinthe: https://github.com/absinthe-graphql/absinthe
• PostgreSQL: https://www.postgresql.org/

Frontend Technologies

• Tailwind: https://tailwindcss.com/
• Base Template: https://github.com/tailwindtoolbox/Nordic-Store
• Phoenix LiveView: https://github.com/phoenixframework/phoenix_live_view
• Neuron GraphQL Client: https://github.com/uesteibar/neuron

Commit Strategy

• Conventional Commits: https://www.conventionalcommits.org/es/v1.0.0/

types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.

Must be one of the following:

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to the CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests
• chore: Anything not related to the previous ones

Samples: (even more samples)

feat: allow provided config object to extend other configs

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Branch Strategy

• Follow Github Flow https://githubflow.github.io/

Each branch must have a related issue.

{issue_number}-{tag}-{name}

Example

1-feat-create-buttons

Issue Strategy

1. Create the issue in Github with explanation. Tag it properly
2. Create the branch in the repo and work on it
3. Send the PR
4. Keep the branch (or archive it if needed)

Testing

• Github Actions: https://github.com/features/actions

Docs

• Asciidoc: https://docs.asciidoctor.org/

[feat] obtain data from backend

Call the Backend and get the data

• https://github.com/uesteibar/neuron

[docs] Improve README

Add a proper Readme