Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/prestashop/hummingbird

hacktoberfest prestashop prestashop-theme theme

Last synced: about 17 hours ago
JSON representation

Host: GitHub
URL: https://github.com/prestashop/hummingbird
Owner: PrestaShop
Created: 2021-06-17T12:26:05.000Z (over 3 years ago)
Default Branch: develop
Last Pushed: 2024-09-17T13:05:31.000Z (10 days ago)
Last Synced: 2024-09-26T11:24:55.568Z (about 17 hours ago)
Topics: hacktoberfest, prestashop, prestashop-theme, theme
Language: Smarty
Homepage:
Size: 9.08 MB
Stars: 79
Watchers: 34
Forks: 76
Open Issues: 55
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

# Hummingbird theme

This is a PrestaShop's theme we are working on. Please, if you work on this theme, use the `8.1.x` branch of PrestaShop to make sure this theme is compatible with the latest `8.1.x` version.

[Read more](https://build.prestashop.com/news/new-theme-announce/) about this theme on the blog.

![image](https://user-images.githubusercontent.com/16455155/199937084-3d2eab3f-dc3e-488f-8b87-e8d4565219b3.png)

## How to build assets

Same as the PrestaShop project, you need at least **NodeJS 16.x** and **NPM 8** in order to build the project.

First you need to install every node module:

`npm ci`

then create a `.env` file inside the *webpack* folder by copying `webpack/.env-example` and complete it with your environment's informations. Please use a free tcp port.

then build assets:

`npm run build`

## Documentation

We use Storybook as a [documentation](https://build.prestashop.com/hummingbird/). As the theme is currently in development, there is a lot of work on documentation. Don't hesitate to add whatever you feel usefull to it.

## Contributing

Please refer to the [contributing guide](https://github.com/PrestaShop/hummingbird/blob/develop/CONTRIBUTING.md)

## Continuous Integration

The CI runs contain stylelint, eslint, TypeScript type checks.

## Continuous Deployment

When develop is merged into master, the Storybook is delivered almost instantly to his public link using a Github Pages.

## License

This theme is released under the [Academic Free License 3.0][AFL-3.0]

[AFL-3.0]: https://opensource.org/licenses/AFL-3.0