korczis / the-scratch

Single Page Application written in Elm with Elixir/Phoenix Backend

About

Single Page Application written in Elm with Elixir/Phoenix Backend

Status

Features

Core

• Accounting/Monitoring
  • Metrics
    • Queries count
    • Query response time Avg
  • Global
  • Per User
  • GraphQL Calls
  • REST API Calls
  • UI
    • Users
    • Admins
  • Scalable
  • Zero-cost (abstraction)
• Admin Interface
  • First created User
• Authentication
  • Email
  • JWT
  • OAuth
    • Github
    • Google
    • Facebook
    • LinkedIn
    • Twitter
  • Sign In
  • Sign Up
  • Zero-cost (abstraction)
• Authorization
  • Permissions
  • Roles
  • ACL / RBAC
  • UI
  • Zero-cost (abstraction)
• Bootstrap Integration
  • Carousel
  • Navigation Bar
• Client Side Logging
• Configuration
  • Configuration Discovery
  • Service Discovery
  • Zero-cost (abstraction)
• CSRF protection
• Documentation
  • Generated - Developers
• Google Analytics
• Google Maps
• GraphQL & Friends
  • GraphQL
  • GraphiQL
  • Relay
• Hot Reloading
• Internationalization
• Loading Indicator/Spinner
• Localization
  • Server-side
  • Client-side
  • Extracted/Generated
  • Shared (Client & Server)
  • Zero-cost (abstraction)
• Multipart Upload
• Persistence (using Abstraction/Ecto)
  • Migrations
  • In-memory
  • No-SQL
    • Couchbase
  • SQL
    • SQLite
    • PostgreSQL
  • Zero-cost (abstraction)
• Presentation
  • Generated HTML5
• Router
• Rust Integration
• Tests
  • Server-side
    • Coverage
  • Client-side
    • Coverage
• User Management
  • Create User
  • Read/Get User
  • Update User
  • Delete User
• Webpack Integration
  • Development
  • Production
• WebSocket
  • Phoenix Websocket Integration
    • Authentication
  • Push Notifications
    • Persistent Changes

Deployment

• Dockerfile
• Kubernetes
• Systemd unit

Fancy

• Stats.js - JavaScript Performance Monitor

Prerequisites

• nodejs
• bower
• elm
• elixir
• phoenix
• postgresql

Getting started

To start your Phoenix app:

• Edit config/config.ex
• Install nodejs dependencies with npm install
• Install bower dependencies with bower install
• Install elm dependencies with elm package install
• Install dependencies with mix deps.get
• Start Phoenix endpoint with mix phoenix.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

How to

Add new page

• Create new sub-folder for component in web/elm/Component folder

Learn more

Elm

• Official website: http://elm-lang.org
• Docs: http://elm-lang.org/docs
• Examples: http://elm-lang.org/examples
• Packages: http://package.elm-lang.org/
• Community: http://elm-lang.org/community
  • Reddit: http://www.reddit.com/r/elm
  • Slack: http://elmlang.herokuapp.com/
  • Twitter: https://twitter.com/elmlang
  • Real Life: https://www.elmlog.com/meetup_groups
  • Mailing List: https://groups.google.com/forum/?fromgroups#!forum/elm-discuss
  • Contributing: http://elm-lang.org/community#contribute

Elixir

• Official Website: https://elixir-lang.org/
• Docs: https://elixir-lang.org/docs.html
• Learning: https://elixir-lang.org/learning.html
• Blog: https://elixir-lang.org/blog/
• Guides: https://elixir-lang.org/getting-started/introduction.html
• Packages: https://hex.pm/
• Install: https://elixir-lang.org/install.html

Phoenix

• 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