vuestorefront / developer.vuestorefront.io

Vue Storefront Developer Portal

Home Page:https://developer.vuestorefront.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Alokai

Community Developer Portal

Welcome to our community developer portal repository. This project is dedicated to all our community members and contributors.

The developer portal is a hub of information about the Alokai framework and the community materials. You will find videos, blog posts, documentation and much more.

GitHub Repository Stars Count Follow Us on Twitter Subscribe on our Youtube Channel Chat with us on Discord

Commitizen friendly License PRs Welcome

#TechForUkraine

Russia’s military aggression against Ukraine.

How can you support Ukrainian civil society?

All help is needed. If you are not able to help locally, by sheltering a fellow Ukrainian, you can also:

How it works?

Tech Stack

The project use as it's tech stack the following technologies:

How do we use components?

In this project we are using two components structures:

  • Atomic Design
  • Active Components

What is Atomic Design?

Atomic design is atoms, molecules, organisms, templates, and pages concurrently working together to create effective interface design systems Atomic Design by Brad Frost

What is Active Components?

The principle of Active Components is to create reusable components which takes data manipulation upon itself, removing the need to add those code bits into a page, component or layout.

How do we use layouts?

We are following the default Nuxt 3 Layout structure.

How do we use pages?

We are following the default Nuxt 3 Pages structure, with automatic route generation.

How do we use composables?

We are following the default Nuxt 3 Composables structure, with automatic import, for most of the composables.

There are other composables, which needs to be imported manually, those are related to specific usages, such as UI or activeComponents.

How do we use content?

We are using Nuxt Content as our content management system. In the content folder you will find, different types of content, like video, blog or documentation.

We are heavily using the front-matter field to manipulate the data and fetch information across different areas of the portal.

How do we use server?

We are following the default Nuxt 3 Server Routes structure.

The server folder has special APIs developed for the usage of the portal, like fetching data from Dev.to, or internal data to render content.

How do we use locales?

All the components, pages and layouts are using internationalization to handle text and time. We are using the Vue i18n plugin to handle the translations.

Deployment

The Alokai developer portal is currently being deployed to the Alokai Cloud Platform.

We are using Deploybot to manage the deployment automatically.

Contributing

If you like the ideas behind Alokai and want to become a contributor - join our Discord server, check the list of the active issues or contact us directly via contributors(at)vuestorefront(dot)io.

If you have discovered a 🐜 or have feature suggestion, feel free to create an issue on GitHub.

Support us

Alokai is and always will be Open Source, released under MIT Licence.

You can support us in various ways:

  • Contribute - this is how the Core Team is supporting the project!
  • Evangelize - tweet about us, take some speaking slot at a tech conference, etc.

Partners

Alokai is a Community effort brought to You by our great Core Team and supported by the following companies.

See Alokai partners directory

Alokai source code is completely free and released under the MIT License.

About

Vue Storefront Developer Portal

https://developer.vuestorefront.io/

License:MIT License


Languages

Language:TypeScript 46.5%Language:Vue 42.4%Language:SCSS 10.6%Language:Dockerfile 0.3%Language:HTML 0.1%Language:JavaScript 0.0%