Elyxel

screenshot of Elyxel
brunch

Elyxel

Community Software

Overview

Elyxel is a platform designed for gathering and sharing stories. It is built using Elixir and Phoenix, and is a fully functional application that can be run on a small production server.

Features

  • Story Sharing: Users can share their stories and experiences with the Elyxel community.
  • Gathering Space: Elyxel provides a space for users to gather and connect with like-minded individuals.
  • Production-Ready: The code base is an example of a fully functional Elixir and Phoenix application that can be run on a production server.

Installation

To set up Elyxel locally, follow these steps:

  1. Install Docker on your machine.
  2. Build the web image using the following command:
docker-compose build web
  1. Start the application using the following command:
docker-compose up
  1. Visit http://elyxel.localhost:8000 in your browser.

To migrate and seed the database, do the following:

  1. Execute the following command to access the running docker container:
docker exec -it elyxel_web_1 /bin/bash
  1. Inside the container, run the Ecto command to set up the database:
mix ecto.setup

To run tests, use one of the following methods:

  1. Execute the following command to access the running docker container:
docker exec -it elyxel_web_1 /bin/bash
  1. Inside the container, run the following command to run the tests:
mix test

OR

docker-compose run --rm web mix test

Summary

Elyxel is a platform that allows users to share and gather stories. It is built using Elixir and Phoenix, and provides a fully functional application code base that can be run on a small production server. The installation process involves setting up Docker, building the web image, and running the application. Database migration, seeding, and running tests are also explained in the installation guide.

brunch
Brunch

Brunch is an older HTML5 build tool like Grunt and Gulp. Capable of static site generation using whatever templating engine you choose.