louim / accent Goto Github PK

Website • GraphiQL

The first developer-oriented translation tool. Accent’s engine coupled with the asynchronous flow between the translator and the developer is what makes Accent the most awesome tool of all.

The Accent API provides a powerful abstraction around the process of translating and maintaining the translations of an app.

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

• Requirements
• Mix commands
• Quickstart
• Environment variables
• Tests
• Heroku
• Contribute

• erlang ~> 20.1
• elixir ~> 1.6.0
• postgres >= 9.4
• node.js >= 8.5.0
• libyaml >= 0.1.7

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

When executing mix commands, you should always make sure that the required environment variables are present. You can source, use nv 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 named postgres listening on port 5432 on localhost.

With nv you inject the environment keys in the context with:

$ nv .env mix <mix command>

1. If you don’t already have it, install nodejs with brew install nodejs
2. If you don’t already have it, install elixir with brew install elixir
3. If you don’t already have it, install libyaml with brew install libyaml
4. If you don’t already have it, install postgres with brew install postgres or the macOS app
5. Install dependencies with mix deps.get and npm --prefix webapp install
6. Create and migrate your database with mix ecto.setup
7. Start Phoenix endpoint with mix phx.server
8. Start Ember server with npm --prefix webapp run start
9. That’s it!

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

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 run mix test.

$ npm --prefix webapp run build
$ mix run ./priv/repo/seeds.exs
$ mix test

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

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 :)

• @simonprev
• @loboulet
• @remiprev
• @charlesdemers
• @ddrmanxbxfr
• @thermech

Accent is © 2015-2018 Mirego and may be freely distributed under the New BSD license. See the LICENSE.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 of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.

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