Skip to content

Commit

Permalink
Add a simple README.md to the sub template
Browse files Browse the repository at this point in the history
  • Loading branch information
ericof committed May 16, 2024
1 parent 36e1f85 commit 2c7cfa1
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions sub/frontend_project/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[![Cookieplone Frontend Project CI](https://github.com/plone/cookieplone-templates/actions/workflows/frontend_addon.yml/badge.svg)](https://github.com/plone/cookieplone-templates/actions/workflows/frontend_addon.yml)
[![Built with Cookiecutter](https://img.shields.io/badge/built%20with-Cookiecutter-ff69b4.svg?logo=cookiecutter)](https://github.com/plone/cookieplone-templates/)
![GitHub](https://img.shields.io/github/license/plone/cookiecutter-plone)
[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# Cookieplone Frontend Project

This is a sub-template -- used by other templates, in automated tests, and for OCI image generation -- accessible with **cookieplone** at the path `sub/frontend_project`.

## Getting Started 🏁

### Prerequisites

- **pipx**: A handy tool for installing and running Python applications.

### Installation Guide πŸ› οΈ

1. **pipx**

```shell
pip install pipx
```
### Generate Your Frontend project πŸŽ‰

```shell
pipx run cookieplone sub/frontend_project --no_input __version_plone_volto=18.0.0-alpha.31
```

## Project Generation Options

These are all the template options that will be prompted by the [Cookiecutter CLI](https://github.com/cookiecutter/cookiecutter) before generating your project.

| Option | Description | Example |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `title` | Your project's human-readable name, capitals and spaces allowed. | **Frontend Project** |
| `author` | This is you! The value goes into places like ``LICENSE``, ``package.json`` and such. | **Our Company** |
| `email` | The email address you want to identify yourself in the project. | **[email protected]** |
| `volto_version` | Volto version to be used. | **18.0.0-alpha.31** |


## Code Quality Assurance 🧐

Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code:

```shell
make format
```

## License πŸ“œ

This project is licensed under the [MIT License](/LICENSE).

## Let's Get Building! πŸš€

Happy coding!

0 comments on commit 2c7cfa1

Please sign in to comment.