README.md

Elixir Companies

A collection of companies using Elixir in production.

Proudly built with Phoenix.

Adding a new company be showcased

• Fork the repo
• Use the helper Mix task to generate the file:

  mix create_company_file {{ your company name }}

-- OR --

• Add your company information to a new /priv/companies/{{company_name}}.exs in the following format:

  # Company file for Acme Corp
  # Created on: 2024-01-01
  
  %{
    name: "Acme Corp",
    website: "https://example.com/",
    github: "https://github.com/example/acme-corp",
    # reference lib/companies/industries.ex for a list of recommended industries to use here
    industry: "Technology",
    location: %{
      city: "City",
      state: "State",
      country: "Country"
    },
    description: """
    Description of Acme Corp goes here.
    """,
    last_changed_on: ~D[2024-01-01]
  }

• Create a pull request adding the new company file

Development

1. Install current elixir, erlang and nodejs versions

   1. This project uses asdf to manage the language versions of the project.

   2. Follow the instructions on asdf#getting-started to install asdf.

   3. Once complete, run the following command to install the language versions:

      asdf install

   -- OR --

   1. If you manage your language versions differently, please reference ~/.tool-versions for the specific versions to run the project.

2. Install elixir and nodejs dependencies with mix setup

3. Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Localization

In order to add a new language to the available list of locales, you have to do the following:

• mix gettext.extract in order to extract all the latest gettext msgids from the code
• mix gettext.merge --priv/gettext in order to merge the latest msgids with the locales.
• mix gettext.merge --priv/gettext --locale locale_code in order the generate the files for the new locale.
• Edit the default.po and errors.po in the priv/gettext/{locale_code}/LC_MESSAGES/ dir. You leave the msgids intact and only touch the msgstr fields, where you translate the text accordingly.