Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amacgregor/crimson_commerce

An OpenSource Ecommerce platform on the Elixir/Phoenix stack, which aims to leverage the power of functional programming for ecommerce.
https://github.com/amacgregor/crimson_commerce

ecommerce ecommerce-platform elixir phoenix

Last synced: about 1 month ago
JSON representation

An OpenSource Ecommerce platform on the Elixir/Phoenix stack, which aims to leverage the power of functional programming for ecommerce.

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Coverage][coveralls-badge]][coveralls-link]





Logo

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](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Goals](#goals)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#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](https://elixir-lang.org/)
* [Phoenix](https://phoenixframework.org/)
* [TailwindCSS](https://tailwindcss.com/)

### 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
```sh
mix archive.install hex phx_new 1.4.10
```
* Node.js
```sh
npm install npm@latest -g
```

### Installation

1. Clone the repo
```sh
git clone https:://github.com/amacgregor/crimson_commerce.git
```
2. Install Elixir dependencies packages
```sh
mix deps.get
```
3. Create and Migrate the database with
```sh
mix ecto.setup
```
4. Install the Node.js dependencies
```sh
cd apps/crimson_commerce_web/assets && npm install
```
5. Start the application
```sh
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](https://example.com)_

## Roadmap

See the [open issues](https://github.com/amacgregor/crimson_commerce/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](https://twitter.com/allanmacgregor) - [email protected]

Project Link: [https://github.com/amacgregor/crimson_commerce](https://github.com/amacgregor/crimson_commerce)

## Acknowledgements

* []()
* []()
* []()

[contributors-shield]: https://img.shields.io/github/contributors/amacgregor/crimson_commerce.svg?style=flat-square
[contributors-url]: https://github.com/amacgregor/crimson_commerce/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/amacgregor/crimson_commerce.svg?style=flat-square
[forks-url]: https://github.com/amacgregor/crimson_commerce/network/members
[stars-shield]: https://img.shields.io/github/stars/amacgregor/crimson_commerce.svg?style=flat-square
[stars-url]: https://github.com/amacgregor/crimson_commerce/stargazers
[issues-shield]: https://img.shields.io/github/issues/amacgregor/crimson_commerce.svg?style=flat-square
[issues-url]: https://github.com/amacgregor/crimson_commerce/issues
[license-shield]: https://img.shields.io/github/license/amacgregor/crimson_commerce.svg?style=flat-square
[license-url]: https://opensource.org/licenses/MIT
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png
[coveralls-badge]: https://coveralls.io/repos/github/amacgregor/crimson_commerce/badge.svg
[coveralls-link]: https://coveralls.io/github/amacgregor/crimson_commerce