Coder Social home page Coder Social logo

Freshcom

Build Status

Fast, scalable and extensible eCommerce backend in Elixir.

Please see an overview of freshcom here.

Getting Started

External Dependencies

Freshcom requires the following external dependencies to work:

  • Postgres for event store and projections
  • Redis for write side state storage

Setup

1. Install Mix Depedencies

$ git clone https://github.com/freshcom/freshcom
$ cd freshcom
$ mix deps.get

2. Set Environment Variables

Once all the mix dependencies are installed we need to config the environment variables. Please copy paste .env.example and rename it to .env add in all the relevant environment variables. Then run source .env to set all the variables.

3. Setup Database

Setup the database with mix freshcom.setup which will do the following for you:

  • Create the projection (read side) database and run all the relevant migrations
  • Create and initialize the eventstore (write side) database

Run

Once you have everything setup you can get into iex with iex -S mix and try calling functions on the top level modules to see if things works properly. For example to create a user:

req = %Request{
  fields: %{
    "name" => "Demo User",
    "username" => "[email protected]",
    "email" => "[email protected]",
    "password" => "test1234",
    "is_term_accepted" => true
  },
  _role_: "system"
}

{:ok, %{data: user}} = Freshcom.Identity.register_user(req)

Roadmap

Base

  • Filter
  • Include
  • Pagination
  • I18N
  • Search
  • Sort
  • Store
  • Validation

Services

  • Identity (Completed)
  • Goods (In Progress) (30%)
  • Inventory
  • Catalogue
  • CRM
  • Finance
  • Storefront
  • Fulfillment
  • Notification

Learn more

Contact

Any question or feedback feel free to find me in the Elixir Slack Channel @rbao, will usually respond within few hours in PST timezone day time.

Freshcom's Projects

freshcom icon freshcom

Fast, scalable and extensible eCommerce backend in Elixir.

freshcom_web icon freshcom_web

Intuitive, developer friendly and highly scalable eCommerce web API built using Elixir & Phoenix

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.