Skip to content

Open Source standalone 💪🏼 CMS on top of @vuejs for @firebase and JAMstack powered e-commerce web apps.

License

Notifications You must be signed in to change notification settings

gabriel0689/ecom-cms

 
 

Repository files navigation

ecom-cms

Open Source standalone CMS (Content Management System) project on top of @vuejs for @firebase and JAMstack powered e-commerce web apps.

INFO: Maintainability contributions welcome Known Vulnerabilities GitHub license GitHub contributors

For contributing to this project visit the Contributing Guide.

We strictly follow the repo Code of Conduct.

Setup

git clone [email protected]:soulsam480/ecom-cms.git
cd ecom-cms
npm install

Put you firebase credentials inside src/firebase/cred.js in the below format

const config = {
    apiKey: "API KEY",
    authDomain: "AUTH DOMAIN",
    databaseURL: "DATABASE URL",
    projectId: "PROJECT ID",
    storageBucket: "STORAGE BUCKET",
    messagingSenderId: "MESSAGE SENDER ID",
    appId: "APP ID",
  };

  export default config;

then

npm run serve

The project dev server will run on localhost:8080

Structure

File Structure

folder guide

  • public folder has all the assets that are to be untouched by webpack while building. They will be injected unmodified.
  • src - has all the code which is to be built into dist for deployment.
  • src/assets - has all the static assets eg. images, fonts, etc.
  • src/components - has all the vue components
  • src/firebase - firebase credentials and exported firebase functions
  • src/models and src/plugins are currently deprecated.
  • src/router - vue router index.js
  • src/store - vuex store index.js
  • src/styles - single default.scss for default style across the project. Specific components and views have their own styles with a scoped attribute.
  • src/views - All views or more precisely views.
  • App.vue - Main vue file which is the container of this project. for more reference go to the reference.
  • main.js - Javascript file that combines the project. for more reference go to the reference.

Configs

  • eslint config inside .eslintrc.js file
  • babel config inside babel.config.js
  • Vue config inside vue.config.js

Features

Current

This CMS does almost all the basic stuff for now. A detailed list of all the features are

  • Complete Product Management _ Add _ Update * Delete
  • Media Management * Media view and Delete
  • Order Management _ Order view _ Order status Update * Color-coded Order Status
Projected
  • Sending Order status mails (Projected)
  • Sending invoices (Projected)
  • Category Management
  • Product Models and Classes management
  • Product Specs management

I have these ideas for the project. If you wish to contribute please visit the contributing guide and open a pull request!

References

Thank you. FOr any help or queries reach me

🕊 twitter / 📧 mail

About

Open Source standalone 💪🏼 CMS on top of @vuejs for @firebase and JAMstack powered e-commerce web apps.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 81.2%
  • JavaScript 9.7%
  • SCSS 8.4%
  • HTML 0.7%