README.md

Crimson Commerce

An open-source Ecommerce platform in Elixir and Phoenix
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
  • Goals
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

CrimsonCommerce is an experimental ecommerce platform build using a functional programming approach and leveraging the power of Erlang/Elixir and the Phoenix framework.

Built With

• Elixir
• Phoenix
• TailwindCSS

Goals

• Highly scalable ecommerce platform
• Provide tools and frameworks to reduce development complexity – both incidental and accidental
• Build an ecommerce framework that developers are happy to use
• Traceability, the ability to know what happened at any point in time to made decisions or solve problems.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Elixir https://elixir-lang.org/install.html
• Phoenix

mix archive.install hex phx_new 1.4.10

• Node.js

npm install npm@latest -g

Installation

1. Clone the repo

git clone https:://github.com/amacgregor/crimson_commerce.git

2. Install Elixir dependencies packages

mix deps.get

3. Create and Migrate the database with

mix ecto.setup

4. Install the Node.js dependencies

cd apps/crimson_commerce_web/assets && npm install

5. Start the application

mix phx.server

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Allan MacGregor - @allanmacgregor - [email protected]

Project Link: https://github.com/amacgregor/crimson_commerce

Acknowledgements