Skip to content

Commit

Permalink
Clarify how to create a Volto project with the frontend only when you… (
Browse files Browse the repository at this point in the history
plone#5674)

Co-authored-by: ichim-david <[email protected]>
  • Loading branch information
stevepiercy and ichim-david authored Jan 24, 2024
1 parent 7dad0ad commit bc53456
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
4 changes: 3 additions & 1 deletion docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ myst:

This chapter describes how to develop Volto core and its libraries, packages, and apps as open source software contributions.

For how to develop a project using Volto, see {doc}`plone:install/index`.
```{seealso}
To create a full Plone project with both frontend and backend, see {doc}`plone:install/create-project` instead.
```


## Monorepo structure
Expand Down
23 changes: 14 additions & 9 deletions docs/source/recipes/creating-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ myst:
"keywords": "Volto, Plone, frontend, React, new, volto project, basic"
---

# Creating a new Volto project
# Create a Volto project without a backend

This document shows how to create a Volto project with the frontend only when you have your own existing backend, such as Plone {term}`Classic UI`, {term}`Nick`, or {term}`Guillotina`.

```{seealso}
This document shows how to create a Volto project with the frontend only.
To create a full Plone project with both frontend and backend, see {doc}`plone:install/create-project` instead.
To contribute to Volto, see {doc}`../contributing/developing-core`.
```

For using Volto for a project—in other words, use Volto as a library—you should use Volto's project generator `@plone/generator-volto`.
It's a boilerplate generator based in Yeoman that will provide you with the basic files and folder structure to bootstrap a Volto site.
It's a boilerplate project generator based on Yeoman that will provide you with the basic files and folder structure to bootstrap a Volto site.
In addition to bootstrapping stand-alone Volto projects, it can also bootstrap Volto add-ons.

1. Open a terminal and execute:
Expand All @@ -35,7 +38,7 @@ In addition to bootstrapping stand-alone Volto projects, it can also bootstrap V
```

2. Answer the questions when prompted, and provide the name of the new app (folder) to be created.
For the sake of this documentation, provide `myvoltoproject` as the project name then.
For the sake of this documentation, use `myvoltoproject` as the project name.

````{note}
You can run the generator with parameters to tailor your requirements.
Expand All @@ -44,20 +47,22 @@ In addition to bootstrapping stand-alone Volto projects, it can also bootstrap V
yo @plone/volto --help
```

or take a look at the [README](https://github.com/plone/volto/blob/main/packages/generator-volto/README.md) for more information.
```{seealso}
[`@plone/generator-volto` `README.md`](https://github.com/plone/volto/blob/main/packages/generator-volto/README.md).
```
````

3. Change directory to the newly created folder `myvoltoapp` (or the one you've chosen).
3. Change your working directory to the newly created folder `myvoltoproject` (or whatever name you entered).

```shell
cd myvoltoapp
```

4. The project is ready to be started, `@plone/generator-volto` already has run the dependencies installations for you.
4. `@plone/generator-volto` installed the dependencies for you.
Start the project.

```shell
yarn start
```

will start the development server, compiling and leaving the app ready at:
http://localhost:3000
This starts the development server, which compiles the project code, and when done, it serves the app at http://localhost:3000.
2 changes: 1 addition & 1 deletion docs/source/recipes/developing-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ myst:

# Developing a project

When you start developing a Plone project, it is recommended that you use Plone's cookiecutter boilerplate generator.
When you start developing a Plone project, it is recommended that you use Plone's cookiecutter boilerplate project generator.
See {doc}`plone:install/create-project` for more information.

The generator will output the project folder structure.
Expand Down
1 change: 1 addition & 0 deletions packages/volto/news/3723.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify how to create a Volto project with the frontend only when you have your own existing backend. @stevepiercy

0 comments on commit bc53456

Please sign in to comment.