Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2kabhishek/phoenix_rest

REST in Phoenix 🦅⚙️
https://github.com/2kabhishek/phoenix_rest

api elixir learning phoenix rest server

Last synced: 6 days ago
JSON representation

REST in Phoenix 🦅⚙️

Host: GitHub
URL: https://github.com/2kabhishek/phoenix_rest
Owner: 2KAbhishek
License: gpl-3.0
Created: 2024-01-20T11:55:44.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-02-11T09:40:06.000Z (11 months ago)
Last Synced: 2024-11-12T23:39:02.580Z (2 months ago)
Topics: api, elixir, learning, phoenix, rest, server
Language: Elixir
Size: 306 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

phoenix_rest

REST in Phoenix 🦅⚙️

A REST API built using Phoenix for learning purposes.

## ✨ Features

- RESTful API built using Phoenix
- Can be used for learning purposes

## ⚡ Setup

### ⚙️ Requirements

- erlang (26.1.1)
- elixir (~1.15)

### 💻 Installation

To install phoenix run:

```bash
mix archive.install hex phx_new
```

Clone the repo

```bash
git clone https://github.com/2kabhishek/phoenix_rest
cd phoenix_rest
```

## 🚀 Usage

To start your Phoenix server:

- Run `mix setup` to install and setup dependencies
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can use [`localhost:4000/api`](http://localhost:4000/api) for API interactions.

## 🧑‍💻 Behind The Code

### 🌈 Inspiration

Wanted to explore Phoenix.

### 💡 Challenges/Learnings

- I had to clean up heroicons assests, doing that on every project where not needed.
- I learned more about the Phoenix and Elixir ecosystem.

### 🧰 Tooling

- [dots2k](https://github.com/2kabhishek/dots2k) — Dev Environment
- [nvim2k](https://github.com/2kabhishek/nvim2k) — Personalized Editor
- [sway2k](https://github.com/2kabhishek/sway2k) — Desktop Environment
- [qute2k](https://github.com/2kabhishek/qute2k) — Personalized Browser

### 🔍 More Info

- [phoenix_rest](https://github.com/2kabhishek/phoenix_rest) — REST API with Phoenix

⭐ hit the star button if you found this useful ⭐