Skip to content

Commit

Permalink
Update readme more
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbromley committed Jan 19, 2022
1 parent 60768ac commit 6ad2c99
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

This is a proof-of-concept demo demonstrating full-stack open-source headless commerce, with a [Remix](https://remix.run) storefront powered by [Vendure](https://www.vendure.io). It is based on the [work of Jacob Ebey](https://github.com/jacob-ebey/remix-ecommerce) which in turn is an adaptation of the [Next.js Commerce](https://github.com/jacob-ebey/remix-ecommerce) project.

## Notes

Jacob's original project forms the basis of the [Remix vs Next.js blog post](https://remix.run/blog/remix-vs-next) and it makes used of some advanced caching & image optimization techniques (described in the post).

This repo has removed these parts because:
1. I wanted to simplify the deployment and do away with a dependency on Redis
2. Vendure includes dynamic image transformations out-of-the-box, so I make use of this capability and further simplify the deployment.

### Limitations

No checkout flow nor customer account management features have yet been implemented.

## Development

Copy `.env.example` to `.env`. Update the Vendure API url if you need to, e.g. to point it at a local
Expand Down

0 comments on commit 6ad2c99

Please sign in to comment.