Cursif

Cursif is a collaborative, scriptable and flexible note-taking application that aimes to help teams manage their projects.

Getting Started

Requirements

• Elixir
• Phoenix
• Postgresql

Configurations

Make sure you have installed the requirement above before continuing.

Connect your database

In project root directorylocalhoste and edit and file named .env. Add the following information inside.

export POSTGRES_USER=<your database username>
export POSTGRES_PASSWORD=<your database password>

Setup the application

• Install dependencies with mix deps.get
• Create and migrate your database with mix ecto.setup

Start the application:

Start Cursif with mix phx.server or inside IEx with iex -S mix phx.server (recommended for development). You can, now, consume the API from localhost:4000/api. You can test queries at localhost:4000/graphiql

To monitor the application, you can access the dashboard at localhost:4000/dashboard from your browser.

Troubleshooting

If the application fails to load the environment variable, execute source .env from the root directory

Resources

Elixir

• Official website
  • Docs
  • Style guide
  • Mix

Phoenix

• Official website
• Docs
  • Guides
  • Ecto

Absinthe & GraphQL

• Absinthe docs
• GraphQL

Contribution

Contribution are always welcomed and appreciated! See the contribution guidelines.