Repository files navigation

The first developer-oriented translation tool
True asynchronous flow between translators and your team.

Demo •Website •GraphiQL

Accent provides a powerful abstraction around the process maintaining translations in a web/native app.

• History. Full history control and actions rollback.Who didwhat,when.
• UI. Simple yet powerful UI to enable translator and developer to be productive.
• CLI.Command line tool to easily add Accent to your developer flow.
• Collaboration. Centralize your discussions around translations.
• GraphQL. The API that powers the UI is open and documented. It’s easy to build a plugin/cli/library around Accent.

Easiest way to run an instance of Accent is by using the offical docker image:https://hub.docker.com/r/mirego/accent

1. The only external dependancy is a PostgreSQL database.
2. Create a.env file. Example:

DATABASE_URL=postgresql://postgres@docker.for.mac.host.internal/accent_developmentDUMMY_LOGIN_ENABLED=1# Required for session management. Must be a 64-byte string.# Generate one using: openssl rand -hex 64SECRET_KEY_BASE=KEY

3. Run the image

$ docker run --env-file .env -p 4000:4000 mirego/accent

This will start the webserver on port 4000, migrate the database to have an up and running Accent instance!

• erlang ~> 26.1
• elixir ~> 1.15
• postgres >= 9.4
• node.js >= 16.19
• libyaml >= 0.1.7

The app is modeled with theTwelve-Factor App architecture, all configurations are stored in the environment.

When executingmix commands, you should always make sure that the required environment variables are present. You cansource, usenv or a custom l33t bash script.

Every following steps assume you have this kind of system.

But Accent can be run with default environment variables if you have a PostgreSQL user namedpostgres listening on port5432 onlocalhost.

Withnv you inject the environment keys in the context with:

$ nv .env mix<mix command>

This is the full development setup. To simply run the app, see theGetting started instructions

1. If you don’t already have it, installnodejs withbrew install nodejs
2. If you don’t already have it, installelixir withbrew install elixir
3. If you don’t already have it, installlibyaml withbrew install libyaml
4. If you don’t already have it, installpostgres withbrew install postgres or the Docker setup as described below.
5. Install dependencies withmake dependencies
6. Create and migrate your database withmix ecto.setup
7. Start Phoenix endpoint withmix phx.server

That’s it! You should now be able to open the app athttp://localhost:4000

The Makefile should be the main entry for common tasks such as tests, linting, Docker, etc. This simplifies the development process since you don’t have to search for which service provides which command.mix,npm,prettier,docker,stylelint, etc are all used in the Makefile.

For the production setup, we use Docker to build an OTP release of the app. With docker-compose, you can run the image locally. Here are the steps to have a working app running locally with Docker:

When running the production env, you need to provide a valid authentication setup in theenvironment section indocker-compose.yml file.See the following sections to see available variables to enable third-party logins or dummy login (email only, no password).

1. Runmake build to build the OTP release with Docker
2. Runmake dev-start-postgresql to start an instance of Postgresql. The instance will run on port 5432 with thepostgres user. You can change those values in thedocker-compose.yml file.
3. Runmake dev-start-application to start the app! The release hook of the release will execute migrations and seeds before starting the webserver on port 4000 (again you can change the settings indocker-compose.yml)

That’s it! You now have a working Accent instance without installing Elixir or NodeJS!

Accent provides a default value for every required environment variable. This means that with the right PostgreSQL setup, you can just runmix phx.server.

Various login providers are included in Accent using Ueberauth to abstract services.

If you want to send emails, you’ll have to configure the following environment variables:

If you want to track performance of Accent, you can configure NewRelic with the following environment variables:

Or use the built-in metrics UI fromTelemetryUI:

You can setup the project witha helm chart like this one. This project usesa fork by andreymaznyak and not this canonical repository. The specs and values may need to be updated if you use this repo.

Accent provides a default value for every required environment variable. This means that with the right PostgreSQL setup (and a few setup commands), you can just runmix test.

$ npm --prefix webapp run build$ mix ecto.setup$ mixtest

The full check that runs in the CI environment can be executed with./priv/scripts/ci-check.sh.

An Heroku-compatibleapp.json makes it easy to deploy the application on Heroku.

Based onthis guide

$> heroku createCreating app... done, ⬢ peaceful-badlands-85887https://peaceful-badlands-85887.herokuapp.com/ | https://git.heroku.com/peaceful-badlands-85887.git$> heroku addons:create heroku-postgresql:hobby-dev --app peaceful-badlands-85887Creating heroku-postgresql:hobby-dev on ⬢ peaceful-badlands-85887... freeDatabase has been created and is available$> heroku config:set FORCE_SSL=true DATABASE_SSL=true DUMMY_LOGIN_ENABLED=true --app peaceful-badlands-85887Setting FORCE_SSL, DATABASE_SSL, DUMMY_LOGIN_ENABLED and restarting ⬢ peaceful-badlands-85887... done$> heroku container:push web --app peaceful-badlands-85887=== Building webYour image has been successfully pushed. You can now release it with the 'container:release' command.$> heroku container:release web --app peaceful-badlands-85887Releasing images web to peaceful-badlands-85887... done

Before opening a pull request, please open an issue first.

Once you’ve made your additions and the test suite passes, go ahead and open a PR!

Don’t forget to run the./priv/scripts/ci-check.sh script to make sure that the CI build will pass :)

Accent is © 2015-2019Mirego and may be freely distributed under theNew BSD license. See theLICENSE.md file.

Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team oftalented people who imagine and build beautiful Web and mobile applications. We come together to share ideas andchange the world.

We alsolove open-source software and we try to give back to the community as much as we can.