Create / launch a postgres instance on your local machine. If you have docker installed, you can use the pre-seed postgres docker image:

docker run -d --name cf_dev_db -p 5432:5432 captainfact/dev-db:latest

• Without Docker (recommended if you want to make changes in the API)

  • mix deps.get
  • mix ecto.migrate
  • iex -S mix

• With Docker

  • Download project's dependencies with ./dev/get_dependencies.sh
  • Migrate your database with ./dev/db_migrate.sh
  • Start server with ./dev/start_server.sh

Following services will be started:

• localhost:4000 - REST API
• localhost:4001 - REST API (https)
• localhost:4002 - GraphQL API
• localhost:4003 - GraphQL API (https)
• localhost:4004 - Atom feed

You can run tests with ./dev/test.sh. You can filter which tests to run by running something like ./dev/test.sh test/your_test_subpath. Check ./dev/test.sh script comments for details.

Elixir offers very nice ways to separate concerns and work with microservices. This application is organized as an umbrella project which allows us to divide CaptainFact API into small apps.

.
├── apps
│   ├── cf => Core functions as a library. **Not deployed**
│   ├── cf_atom_feed => Atom feed.
│   ├── cf_graphql => GraphQL API (public).
│   ├── cf_jobs => Jobs.
│   ├── cf_opengraph => An app that generate opengraph tags.
│   ├── cf_rest_api => REST/WS API (private).
│   └── db => DB repository and schemas **Not deployed**
│       ├── lib
│       │   ├── db
│       │   ├── db_schema => Contains all the schemas (Video, Speaker, Comment...etc)
│       │   ├── db_type => Special types (SpeakerPicture...etc)
│       │   └── db_utils => Some utils functions
│       └── priv
│           └── repo/migrations => All DB migrations files
├── README.md => You're reading it right now. Are you?
├── rel => Release configs & tools
│   ├── commands => Commands that will be available to run on the release (seed DB...etc)
│   ├── hooks => Some hooks for automatically run commands when release run.
│   ├── runtime_config => Runtime configurations for all apps.
│   └── config.exs => Releases configuration.

Code should follow Elixy Style Guide and Credo style guide as much as possible.

Avoid lines longer than 80 characters, never go beyond 110 characters.

• Community discussions and documentation
• Frontend
• Extension
• Overlay injector