/starred_repo_searcher

Primary LanguageElixir

Starred Repos Searcher

elixir_logo

Technical test Backend

Made by

Introduction   |    Getting started   |    How to test  

Introduction

I've challenged myself to make this programming exercise with an language that i'm a beginner, so this is written with Elixir/Phoenix.

Getting started

First of all you need to clone this repository.

then you can open the project and search the file inside config/dev.exs, here you can set up your database connection.

Here i'm using postgres as database, you need to have postgres in your machine or just use an docker image. Now you can follow the nexts steps.

  • Install dependencies with mix deps.get

  • Create and migrate your database with mix ecto.setup

  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

How to test

Inside the root folder of the project you can see a file named ìnsomnia-guide.json, you can use that to see the endpointds avaibles for the api.

In your bash you can use this command mix testto see if the tests are up and running properly, i also added the capability to see the coverage of our tests. You can use this command mix coverallsto see in your bash or if you want something more visual you can use mix coveralls.html, this command generate an html file inside the cover folder, then open this file in your browser.