https://github.com/fabiornobrega/ecommerce-elixir-phoenix-example
This small project is a simple example of a e-commerce build with elixir using a phoenix framework
https://github.com/fabiornobrega/ecommerce-elixir-phoenix-example
elixir elixir-phoenix
Last synced: 12 months ago
JSON representation
This small project is a simple example of a e-commerce build with elixir using a phoenix framework
- Host: GitHub
- URL: https://github.com/fabiornobrega/ecommerce-elixir-phoenix-example
- Owner: FabioRNobrega
- License: mit
- Created: 2022-10-12T14:26:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-18T15:05:03.000Z (over 3 years ago)
- Last Synced: 2025-01-16T06:40:51.936Z (over 1 year ago)
- Topics: elixir, elixir-phoenix
- Language: Elixir
- Homepage:
- Size: 158 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# E-Commerce Example | Farno
This is a simple e-commerce application with phoenix and elixir, this project was made following the book [Phoenix in Action](http://phoenixinaction.com) by [Geoffrey Lessel](https://twitter.com/geolessel) on Manning. I made some improvements such as layout, but the core knowledge is still there.
> Support Lessel buy his book at [Phoenix in Action](http://phoenixinaction.com)
I use:
- Erlang/OTP 24
- IEx 1.13.4 (compiled with Erlang/OTP 22)
- Phoenix v1.6
- Postgres (PostgreSQL) 9.6.21
Table of contents
=================
- [Install](#install)
- [Usage](#usage)
- [Tests](#tests)
- [Git Guideline](#git-guideline)
- [Branches Guide](#branches-guide)
## Install
For run this application you need to have erlang and Elixir installed. You can follow the [ElixirSchool](https://elixirschool.com/en/lessons/basics/basics#installing-elixir-1) tutorial to help you with that.
## Usage
Clone this repo and cd into and install dependencies with
```bash
mix deps.get
```
```bash
mix ecto.migrate
```
Start this umbrella app going inside the `umbrella_auction/apps/auction` and run:
```bash
mix -S iex
```
and to run the Phoenix app go to `umbrella_auction/apps/auction_web` and run:
`mix phx.server` or go inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
## Tests
The tests are made using [ExUnit](https://hexdocs.pm/ex_unit/main/ExUnit.html) and can be found on the test folder. To run use
```bash
mix test
```
## Git Guideline
Create your branches and commits using the English language and following this guideline.
#### Branches
The branches in this repo fallow the ordet of chapters from [Phoenix in Action](http://phoenixinaction.com) book. That way is compose by
`BOOK_PART/chapter-number`
ex: `PART2/chapter-004`
That way you can fallow step by step all de development of this application using the book as reference.
#### Commits prefix
- Chore: `chore(context): message`
- Feat: `feat(context): message`
- Fix: `fix(context): message`
- Refactor: `refactor(context): message`
- Tests: `tests(context): message`
- Docs: `docs(context): message`
## Branches Guide
#### **Index**
- [Chapter 04](#chapter-04)
- [Chapter 05](#chapter-05)
- [Chapter 06](#chapter-06)
- [Chapter 07](#chapter-07)
- [Chapter 08](#chapter-08)
- [Chapter 09](#chapter-09)
- [Chapter 10](#chapter-10)
- [Chapter 11](#chapter-11)
- [Chapter 12](#chapter-12)
- [Chapter 13](#chapter-13)
- [Chapter 14](#chapter-14)
- [Extras](#extras)
---
### Chapter 04
> Branch **PART2/chapter-004**
Your auction application in chapter 4 consisted of a fake repo, a public interface layer
to access the data in the repo, and an Item struct that defined the data structure of
your auction items. All that code—three modules—existed in a single file. Once you
start adding more functionality, that kind of project structure will become unmaintainable.
---
### Chapter 05
> Branch **PART2/chapter-005**
In this chapter we transform you single file auction application in one umbrella application with one app inside.
Then you use multiple files to organize or modules. And talk about packages and add Ecto and Postgres to handle with real data.
---
### Chapter 06
> Branch **PART2/chapter-006**
In this chapter we create a Phoenix application inside an existing umbrella app, and we use the old Auction app as data to our template, and now we are able to render the HTML in a local view [localhost:4000](http://localhost:4000)
---
### Chapter 07
> Branch **PART2/chapter-007**
In this chapter we create a a connection between the application with PostgreSQL using [Ecto](https://hexdocs.pm/ecto/Ecto.html). With that set we create now a real database for the items and and a simple Create, Read and Delete system.
---
### Chapter 08
> Branch **PART2/chapter-008**
In this chapter we create a update and learning a little about ecto changeset and validations functions.
---
### Chapter 09
> Branch**PART2/chapter-009**
In this chapter we create RESTfull resource contains actions for index, show, new, create, edit update. With HTML Templates and Controllers.
---
### Chapter 10
> Branch **PART2/chapter-010**
In this chapter, we create a simple session control with [pbkdf2_elixir](https://hex.pm/packages/pbkdf2_elixir). Added the possibility of creating a user and then
enable the same to log in and log out.
---
### Chapter 11
> Branch **PART2/chapter-011**
In this chapter, we create relations between user, bits and items to be able to handle bids on site per user.
---
### Chapter 12
> Branch **PART3/chapter-012**
You probably thinking why this branch doesn't exist, but here is true, this chapter covers phoenix channels but now I day is better you use [Phoenix LiveView](https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html) to handle real-time communication to users.
---
### Chapter 13
> Branch **PART3/chapter-013**
In this chapter, we create a API for external / public usage to list items with bids and all the items on the data base.
---
### Chapter 14
> Branch **PART3/chapter-014**
In this chapter, covered ExUnit tests and Ex_doc with `@docs` and `@moduledoc`
---
### Extras
> Branch **PART4/extras**
This part is my own addition to this study. So I have added a new layout, test, documentation, and a docker to run more easily.