Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zacksiri committed Feb 22, 2024
1 parent d119651 commit ebd2492
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ npm-debug.log

.envrc

.DS_Store

19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,31 @@ Polar is an image server for LXD / Incus. It has some useful features like
+ Feed specific to incus / lxd, you can choose when creating credentials.
+ Users can create `spaces` to manage multiple credentials.

The build system for polar is called [icepak](https://github.com/upmaru/icepak). It's designed to run as a github action, you can see it in action [here](https://github.com/upmaru/opsmaru-images).

## Basic Architecture

![basic design](/design.png)

## Development

Clone the repository and start the server with
Make sure you have Elixir / OTP installed. If you have asdf in your environment simply run

```shell
asdf install
```

### Install Dependencies

Install dependencies using mix:

```shell
mix deps.get
```

## Start Server

You can start the server with the following command. It will be hosted on port 4000

```shell
iex -S mix phx.server
Expand Down

0 comments on commit ebd2492

Please sign in to comment.