These are the docs of the Core Repo itself. If you are looking for the Liqen API docs, go to http://exacs.github.io/liqen-docs
This is the Core of the Liqen Project, the Wikipedia of Facts.
We offer you a couple of ways to install and deploy this application.
You can use the following button to deploy the App in Heroku.
It will install and setup everything for you, i.e.:
- A PostgreSQL Database (free Tier)
- Elixir and Phoenix build stacks
- Procfile
- Autogenerated secure secret keys
When prompted, set the environmental variable APP_URL_HOST
with the URL of your app (without the https part). Set it your own custom domain name or the heroku apps domain name.
This means that, if you are planning to use a herokuapp.com
domain, you should choose your App name. For example if your app name is my-app
, the generated URL will be https://my-app.herokuapp.com
and you have to set the variable with the value: my-app.herokuapp.com
.
To install all and start the server
docker-compose up
Once you have all installed, make sure to create and migrate the database
docker-compose run web mix ecto.create
docker-compose run web mix ecto.migrate
To run this application you need to download
- PostgreSQL 9.4 or higher.
- Phoenix Framework and its dependencies, including Elixir and Erlang.
Then, to start the app (in development mode)
- Install dependencies with
mix deps.get
- Create and migrate your database with
mix ecto.create && mix ecto.migrate
- Install Node.js dependencies with
npm install
- Start Phoenix endpoint with
mix phoenix.server
Now you can visit localhost:4000
from your browser.
Please check the Phoenix deployment guides.
- Official website: http://www.phoenixframework.org/
- Guides: http://phoenixframework.org/docs/overview
- Docs: https://hexdocs.pm/phoenix
- Mailing list: http://groups.google.com/group/phoenix-talk
- Source: https://github.com/phoenixframework/phoenix