You need to install Elixir. We recommand using asdf.
Check their documentation on how to install it, then run asdf install from
root captain-fact-api folder.
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
mix deps.get--> Get dependenciesmix ecto.migrate--> Migrate DBiex -S mix--> Start project
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 also see all the mail sent by going to http://localhost:4000/_dev/mail
mix test--> Run testsmix test.watch--> Run tests watchermix format--> Format codemix ecto.gen.migration [migration_name]--> Generate migration
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.