README.md

Rocketlivery

ENGLISH | PORTUGUÊS | 日本語

About

Rocketlivery is a complex application delivery application, with a report generator for the orders done with cron jobs.

Project made on Ignite with Rafael Camarda at Elixir Journey.

📐 Technology

It was used on development:

• Elixir
• Decimal
• Credo
• Exmachina
• Pbkdf2
• Excoveralls
• Tesla
• Bypass
• Mox
• Guardian

👀 Preview

🔌 Requirements

Before to start, you will need have installed on your computer these programs:

• Git
• Elixir

Also is good have a code editor like VSCode.

💡 Do it by yourself

Cloning

In your terminal clone the repository and install the dependencies.

- to clone the repository

git clone https://github.com/ruanmoreiraofc/rocketlivery-elixir.git

- to enter into the folder

cd rocketlivery-elixir

- to install the dependencies

mix deps.get

Setup Database

First of all you should setup ./config/dev.exs and ./config/test.exs, then run this command in your terminal:

mix ecto.setup

Migrations

If need to create a migration, you can do that using this command in your terminal

- to create a migration

mix ecto.gen.migration <migration_name>

- to consume the migrations

mix ecto.migrate

Guardian

In order to generate bearer tokens for your api, you need setup ./config/config.secrets.example, replacing the placeholders with valid data and renaming it to config.secrets.exs.

(ONLY ON bash) you can paste this command to help you out

GUARDIAN_SECRET=$(mix guardian.gen.secret) \
bash .github/scripts/setup_secret.sh

Usage

Now see the result with:

- to test the project

mix test

- to run the server

mix phx.server

It will expose the app in localhost:4000

Insomnia

You can use the insomnia file to make simple requests to test on development environment!

⚖️ License

This project is under the MIT license. See the LICENSE for more information.

👦 Author

Made with ❤️ by Ruan Moreira de Jesus!