Git Product home page Git Product logo

ex-shop's Introduction

Authentic Pixels

Digital goods shop & blog created using Phoenix Framework (Elixir)

This is the source code for my new website - Authentic Pixels. Through Authentic Pixels, I plan to deliver high quality free & premium web resources including Bootstrap HTML templates, startup landing pages, UI kits, mockups & themes for Ghost & Wordpress.


Demo & Screenshots

View the live website here - Authentic Pixels

Here are some screenshots of the admin area.

Authentic Pixels - Product Editor

Authentic Pixels - Dashboard

This project has been a great learning experience for me. Coming from Ruby on Rails, there are a lot of things that are done differently in Elixir/Phoenix and building this app has helped me understand the "Elixir way" of doing things.

Some of the things that this project helped me wrap my head around are -

  1. Nested records & associations (e.g: Product has many variants)
  2. Handling many-to-many associations and validating them
  3. Uploading images
  4. Testing
  5. Switching to Webpack from Brunch
  6. Creating Sitemaps and running a cron task to regularly run the sitemap generation task
  7. Deploying (to a Digital Ocean box using Dokku)
  8. Sending HTML emails.
  9. Separating admin area from frontend using differnt layouts and scopes in router.ex

I will be writing about this is a lot more detail on my blog soon.


Installation

  1. Clone the repository and install the dependencies
git clone [email protected]:authentic-pixels/exshop.git
cd exshop
mix deps.get
npm install
  1. Create the database and run the migrations
mix ecto.create
mix ecto.migrate
  1. Create an admin user. You can change the email and password in priv/repo/seeds.exs file.
mix run priv/repo/seeds.exs
  1. Add your Cloudinary keys. Create a file called dev.secret.exs inside config folder with the following contents. Be sure to change the 'name', 'api_key' and 'api_secret' fields.
use Mix.Config
config :cloudini,
  api_key: "CHANGE_ME",
  api_secret: "CHANGE_ME",
  name: "CHANGE_ME",
  stub_requests: false,
  http_options: [timeout: 15000]
  1. Start the server
iex -S mix phoenix.server

Now visit http://localhost:4000/ to see the frontend version. To access the admin area, visit http://localhost:4000/admin. You can login with the email and password set in priv/repo/seeds.exs.


Running tests

  1. Set up your test database
MIX_ENV=test mix ecto.reset
  1. Run all the tests on file change
mix test.watch

Todo

  • Create sitemaps
  • Cron task to update sitemaps frequently
  • Add archives page to blog
  • Create RSS feeds
  • Explore Google AMP versions for product/post pages
  • Write integration tests for admin area

Credits

The Elixir/Phoenix community is really welcoming & responsive. There are tons of nice examples and packages that helped me with my learning. Here are some of the elixir packages that I am using in this project -

  • Comeonin for password hashing
  • test.watch for running tests
  • Bamboo for sending emails
  • Cloudini for uploading images to Cloudinary
  • Quantum for running cron tasks
  • Curtail for truncating HTML snippets
  • XML builder for generating Sitemaps
  • Kerosene for pagination

For any questions/comments/suggestions, drop me a line at - [email protected] or send me a tweet.

Thanks,

Bharani, Authentic Pixels - Free & Premium Web Resources

ex-shop's People

Contributors

bharani91 avatar

Watchers

 avatar  avatar

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.