Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamiyuzu/neko_caffe
Elixir talk auxiliary repo
https://github.com/kamiyuzu/neko_caffe
Last synced: about 2 months ago
JSON representation
Elixir talk auxiliary repo
- Host: GitHub
- URL: https://github.com/kamiyuzu/neko_caffe
- Owner: kamiyuzu
- License: mit
- Created: 2020-07-26T19:07:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T12:31:00.000Z (about 2 years ago)
- Last Synced: 2023-03-09T09:11:06.284Z (almost 2 years ago)
- Language: Elixir
- Size: 2.19 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NekoCaffe
## Development environment
- Install elixir/erlang using `asdf`
Information to install asdf can be found [here](https://github.com/asdf-vm/asdf)
```bash
asdf plugin-add erlang https://github.com/asdf-vm/asdf-erlang
asdf plugin-add elixir https://github.com/asdf-vm/asdf-elixir
```
```bash
asdf install
```
or install Erlang and Elixir on your machine.
### Development environment variables
In the [.env](.env) file environments vars needs to be defined for the local environments. Those need to be loaded when working with this project. To do so, one can manually execute:
```bash
source .env
```
or automate this process using [direnv](https://direnv.net/).
```bash
# Install direnv using brew
$ brew install direnv
# From the project folder
$ direnv allow
```
Continue with the instructions [here](https://github.com/direnv/direnv#setup)
### Development environment database
- Install docker&docker-compose
Information to install docker can be found [here](https://docs.docker.com/get-docker/)
Information to install docker-compose can be found [here](https://docs.docker.com/compose/install/)
Set up postgresql database:
```bash
$ docker network create neko_caffe_network
$ docker-compose up
```
## Phoenix framework
To start your Phoenix server:
* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.setup`
* Install Node.js dependencies with `npm install` inside the `assets` directory
* Start Phoenix endpoint with `mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## Learn more
* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix