mirror of
https://github.com/strapi/strapi.git
synced 2025-11-01 10:23:34 +00:00
Jim LAURIE
GitHub
commit
cfa8719eac
@ -39,7 +39,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -75,7 +75,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -110,7 +110,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -229,7 +229,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -261,7 +261,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -366,7 +366,7 @@ Next, you need to install **PM2 Runtime** and configure the `ecosystem.config.js
|
||||
|
||||
#### 6. Install **PM2 Runtime**
|
||||
|
||||
[PM2 Runtime](https://pm2.io/doc/en/runtime/overview/?utm_source=pm2&utm_medium=website&utm_campaign=rebranding) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
[PM2 Runtime](https://pm2.keymetrics.io) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
|
||||
Ensure you are logged in as a **non-root** user. You will install **PM2** globally:
|
||||
|
||||
@ -374,7 +374,7 @@ Ensure you are logged in as a **non-root** user. You will install **PM2** global
|
||||
npm install pm2@latest -g
|
||||
```
|
||||
|
||||
Now, you will need to configure an `ecosystem.config.js` file. This file will set `env` variables that connect Strapi to your database. It will also be used to restart your project whenever any changes are made to files within the Strapi file system itself (such as when an update arrived from Github). You can read more about this file [here](https://pm2.io/doc/en/runtime/guide/development-tools/).
|
||||
Now, you will need to configure an `ecosystem.config.js` file. This file will set `env` variables that connect Strapi to your database. It will also be used to restart your project whenever any changes are made to files within the Strapi file system itself (such as when an update arrived from Github). You can read more about this file [here](https://pm2.keymetrics.io/docs/usage/application-declaration/).
|
||||
|
||||
- You will need to open your `nano` editor and then `copy/paste` the following:
|
||||
|
||||
@ -425,7 +425,7 @@ Earlier, `Port 1337` was allowed access for **testing and setup** purposes. Afte
|
||||
Follow the steps below to have your app launch on system startup.
|
||||
|
||||
::: tip
|
||||
These steps are based on the [PM2 Runtime Startup Hook Guide](https://pm2.io/doc/en/runtime/guide/startup-hook/).
|
||||
These steps are based on the [PM2 Runtime Startup Guide](https://pm2.keymetrics.io/docs/usage/startup/#startup-script-generator).
|
||||
:::
|
||||
|
||||
- Generate and configure a startup script to launch PM2, it will generate a Startup Script to copy/paste, do so:
|
||||
|
||||
@ -241,7 +241,7 @@ You will next need to [install and configure PM2 Runtime](#install-and-configure
|
||||
|
||||
### Install and configure PM2 Runtime
|
||||
|
||||
[PM2 Runtime](https://pm2.io/doc/en/runtime/overview/?utm_source=pm2&utm_medium=website&utm_campaign=rebranding) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
[PM2 Runtime](https://pm2.keymetrics.io) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
|
||||
Ensure you are logged in as a **non-root** user. You will install **PM2** globally:
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Deploying **databases** along with Strapi is covered in the [Databases Guide](..
|
||||
|
||||
## Hosting Provider Guides
|
||||
|
||||
Manual guides for deployment on various platforms, for One-click and docker please see the [installation](./installation) guides.
|
||||
Manual guides for deployment on various platforms, for One-click and docker please see the [installation](..getting-started/installation.md) guides.
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/amazon-aws.html">
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
### Installation guides
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/cli">
|
||||
<InstallLink link="../installation/cli.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 271"><g><path d="M116.553,0 L0,67.953 L0,98.096 L49.665,127.882 L91.366,105.163 L91.366,78.74 L179.665,28.034 L241.711,63.77 L241.637,135.222 L156.567,184.231 L128.082,173.694 L90.165,197.882 L91.128,255.785 L117.233,270.858 L234.743,203.897 L234.743,163.65 L221.531,170.761 L221.531,196.347 L117.267,255.461 L104.352,248.005 L103.644,205.48 L128.114,189.128 L157.607,199.658 L256,142.912 L255.065,55.656 L179.678,12.633 L78.016,71.009 L78.016,97.419 L49.824,112.41 L13.35,90.536 L13.35,75.622 L116.243,15.636 L137.841,29.399 L150.89,21.886 L116.553,0 Z M186.0696,71.0918 L164.1876,84.3678 L164.7436,109.9558 L187.1816,122.2678 L209.0636,108.9918 L208.5076,83.4048 L186.0696,71.0918 Z M186.3206,82.6508 L198.6226,89.4018 L198.9276,103.4308 L186.9306,110.7088 L174.6286,103.9588 L174.3236,89.9298 L186.3206,82.6508 Z M73.701,141.0235 L70.738,135.4095 C70.086,134.1755 68.558,133.7035 67.324,134.3545 L47.931,144.5855 C46.697,145.2365 46.224,146.7655 46.876,148.0005 L49.84,153.6175 C50.491,154.8515 52.02,155.3245 53.254,154.6725 L72.645,144.4385 C73.88,143.7865 74.352,142.2575 73.701,141.0235 M84.9168,158.0703 L81.9548,152.4543 C81.2838,151.1813 79.6868,150.7253 78.4438,151.4513 L45.7398,170.5723 C44.5718,171.2563 44.1488,172.7373 44.7798,173.9333 L47.7418,179.5493 C48.4138,180.8223 50.0108,181.2783 51.2528,180.5523 L83.9578,161.4313 C85.1248,160.7483 85.5478,159.2673 84.9168,158.0703 M87.9705,169.6055 L49.5225,191.7065 C48.3435,192.3835 47.9115,193.8735 48.5475,195.0765 L51.5105,200.6915 C52.1785,201.9575 53.7635,202.4165 55.0045,201.7035 L93.4525,179.6025 C94.6325,178.9245 95.0635,177.4345 94.4285,176.2315 L91.4645,170.6165 C90.7965,169.3515 89.2115,168.8925 87.9705,169.6055" fill="#FFF"/></g></svg>
|
||||
</template>
|
||||
@ -15,7 +15,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/docker">
|
||||
<InstallLink link="../installation/docker.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="34" height="23"><g fill="#fff" fill-rule="evenodd"><path d="M18.8017 10.5442h3.4333v-3.101h-3.4333zM14.745 10.5442h3.4333v-3.101H14.745v3.101zM10.6892 10.5442h3.4325v-3.101h-3.4334v3.101zM6.6316 10.5442h3.4334v-3.101H6.6316zM2.5759 10.5442h3.4324v-3.101H2.576v3.101zM6.6326 6.8226h3.4324v-3.101H6.6316v3.101zM10.6892 6.8226h3.4325v-3.101h-3.4334v3.101zM14.745 6.8226h3.4333v-3.101H14.745v3.101zM14.745 3.101h3.4333V0H14.745v3.101z"></path><path d="M28.752 8.3043c-.1708-1.2412-.8667-2.317-2.1326-3.2901l-.727-.482-.4866.7243c-.6197.9309-.9318 2.2216-.829 3.46.046.4351.19 1.2145.6408 1.8993-.4498.2405-1.3366.572-2.5144.549H.1285l-.045.2589c-.2111 1.2439-.2075 5.1252 2.329 8.1087 1.9269 2.2675 4.8168 3.4178 8.5889 3.4178 8.1757 0 14.2245-3.741 17.0565-10.5406 1.1136.022 3.5132.0064 4.7461-2.3326.0312-.0533.1056-.1947.3204-.638l.1184-.2424-.693-.46c-.75-.4984-2.4723-.681-3.7979-.4323z"></path></g></svg>
|
||||
</template>
|
||||
@ -27,7 +27,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/digitalocean-one-click">
|
||||
<InstallLink link="../installation/digitalocean-one-click.html">
|
||||
<template #icon>
|
||||
<svg width="178" height="177" viewBox="0 0 178 177" xmlns="http://www.w3.org/2000/svg"><g fill="#fff" fill-rule="evenodd"><path d="M89 176.5v-34.2c36.2 0 64.3-35.9 50.4-74-5.1-14-16.4-25.3-30.5-30.4-38.1-13.8-74 14.2-74 50.4H.8C.8 30.6 56.6-14.4 117.1 4.5c26.4 8.3 47.5 29.3 55.7 55.7 18.9 60.5-26.1 116.3-83.8 116.3z" fill-rule="nonzero"></path><path d="M89.1 142.5H55v-34.1h34.1zM55 168.6H28.9v-26.1H55zM28.9 142.5H7v-21.9h21.9v21.9z"></path></g></svg>
|
||||
</template>
|
||||
@ -39,7 +39,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/platformsh">
|
||||
<InstallLink link="../installation/platformsh.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><defs><style>.bcac695a-a0a4-4100-84fd-61ecc421091c{fill:#0a0a0a;}.fc8dd422-fb02-4822-a57e-c20c8b5eef7c{fill:#fff;}</style></defs><g id="b5f9bb49-1614-4b22-8c04-f5182c1803f5" data-name="Layer 2"><g id="b2a28560-5e48-4435-accd-e149b4f96cc0" data-name="Layer 1"><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="10.72" width="28.55" height="11.35"/><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="35.42" width="28.55" height="3.86"/><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="25.74" width="28.55" height="5.82"/></g></g></svg>
|
||||
</template>
|
||||
@ -52,4 +52,4 @@
|
||||
|
||||
### Deployment guides
|
||||
|
||||
For a more detailed overview of deployment please see the [related documentation](./deployment).
|
||||
For a more detailed overview of deployment please see the [related documentation](./deployment.md).
|
||||
|
||||
@ -8,7 +8,7 @@ Get ready to get Strapi up and running in **less than 5 minutes** 🚀.
|
||||
|
||||
_For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.md)._
|
||||
|
||||
(Before continuing, please make sure [Node.js and npm are properly installed](install-requirements.md) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).)
|
||||
(Before continuing, please make sure [Node.js and npm are properly installed](../installation/cli.html#step-1-make-sure-requirements-are-met) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).)
|
||||
|
||||
## 1. Install Strapi and Create a new project
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ But we don't want to use [parameters](../content-api/parameters.md) (eg. /articl
|
||||
|
||||
To be able to do that, you have first to understand some concepts.
|
||||
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/endpoint.md).
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/api-endpoints.md).
|
||||
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controller.md) that exist by default when a content type is created.
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controllers.md) that exist by default when a content type is created.
|
||||
|
||||
If you check the controller file of your generated API `./api/{content-type}/controller/{Content-Type}.js`, you will see an empty file. It is because all the default logic is managed by Strapi. But you can override these actions with your own code.
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ What we want here is to add some custom logic and call the email service when a
|
||||
|
||||
To be able to do that, you have first to understand some concepts.
|
||||
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/endpoint.md).
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/api-endpoint.md).
|
||||
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controller.md) that exist by default when a content type is created.
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controllers.md) that exist by default when a content type is created.
|
||||
|
||||
If you check the controller file of your generated API `./api/{content-type}/controller/{Content-Type}.js`, you will see an empty file. It is because all the default logic is managed by Strapi. But you can override these actions with your own code.
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Then, delete your old `plugins` folder and replace it with the new one.
|
||||
|
||||
## ⚠️ Bookshelf (Postgres and MySQL)
|
||||
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15) Bookshelf section.
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15.md) Bookshelf section.
|
||||
|
||||
Go in [diff files](https://github.com/strapi/strapi/compare/v3.0.0-alpha.15...v3.0.0-alpha.16) and search for following files:
|
||||
|
||||
@ -68,7 +68,7 @@ You will have to update all your service by applying the diff.
|
||||
|
||||
## ⚠️ Mongoose (Mongo)
|
||||
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15) Mongoose section.
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15.md) Mongoose section.
|
||||
|
||||
Go in [diff files](https://github.com/strapi/strapi/compare/v3.0.0-alpha.15...v3.0.0-alpha.16) and search for following files:
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# GraphQL
|
||||
|
||||
By default Strapi create [REST endpoints](../content-api/api-endpoints) for each of your content types. With the GraphQL plugin, you will be able to add a GraphQL endpoint to fetch and mutate your content.
|
||||
By default Strapi create [REST endpoints](../content-api/api-endpoints.md) for each of your content types. With the GraphQL plugin, you will be able to add a GraphQL endpoint to fetch and mutate your content.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -75,7 +75,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -110,7 +110,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -229,7 +229,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
@ -261,7 +261,7 @@ module.exports = {
|
||||
```
|
||||
|
||||
- `params` (object): this represent filters for your find request.<br>
|
||||
The object follow the URL query format, [refer to this documentation.](content-api/parameters.html).
|
||||
The object follow the URL query format, [refer to this documentation.](../content-api/parameters.html).
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -366,7 +366,7 @@ Next, you need to install **PM2 Runtime** and configure the `ecosystem.config.js
|
||||
|
||||
#### 6. Install **PM2 Runtime**
|
||||
|
||||
[PM2 Runtime](https://pm2.io/doc/en/runtime/overview/?utm_source=pm2&utm_medium=website&utm_campaign=rebranding) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
[PM2 Runtime](https://pm2.keymetrics.io) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
|
||||
Ensure you are logged in as a **non-root** user. You will install **PM2** globally:
|
||||
|
||||
@ -374,7 +374,7 @@ Ensure you are logged in as a **non-root** user. You will install **PM2** global
|
||||
npm install pm2@latest -g
|
||||
```
|
||||
|
||||
Now, you will need to configure an `ecosystem.config.js` file. This file will set `env` variables that connect Strapi to your database. It will also be used to restart your project whenever any changes are made to files within the Strapi file system itself (such as when an update arrived from Github). You can read more about this file [here](https://pm2.io/doc/en/runtime/guide/development-tools/).
|
||||
Now, you will need to configure an `ecosystem.config.js` file. This file will set `env` variables that connect Strapi to your database. It will also be used to restart your project whenever any changes are made to files within the Strapi file system itself (such as when an update arrived from Github). You can read more about this file [here](https://pm2.keymetrics.io/docs/usage/application-declaration/).
|
||||
|
||||
- You will need to open your `nano` editor and then `copy/paste` the following:
|
||||
|
||||
@ -437,7 +437,7 @@ Earlier, `Port 1337` was allowed access for **testing and setup** purposes. Afte
|
||||
Follow the steps below to have your app launch on system startup.
|
||||
|
||||
::: tip
|
||||
These steps are based on the [PM2 Runtime Startup Hook Guide](https://pm2.io/doc/en/runtime/guide/startup-hook/).
|
||||
These steps are based on the [PM2 Runtime Startup Guide](https://pm2.keymetrics.io/docs/usage/startup/#startup-script-generator).
|
||||
:::
|
||||
|
||||
- Generate and configure a startup script to launch PM2, it will generate a Startup Script to copy/paste, do so:
|
||||
|
||||
@ -241,7 +241,7 @@ You will next need to [install and configure PM2 Runtime](#install-and-configure
|
||||
|
||||
### Install and configure PM2 Runtime
|
||||
|
||||
[PM2 Runtime](https://pm2.io/doc/en/runtime/overview/?utm_source=pm2&utm_medium=website&utm_campaign=rebranding) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
[PM2 Runtime](https://pm2.keymetrics.io) allows you to keep your Strapi project alive and to reload it without downtime.
|
||||
|
||||
Ensure you are logged in as a **non-root** user. You will install **PM2** globally:
|
||||
|
||||
|
||||
@ -8,10 +8,10 @@ Deploying **databases** along with Strapi is covered in the [Databases Guide](..
|
||||
|
||||
## Hosting Provider Guides
|
||||
|
||||
Manual guides for deployment on various platforms, for One-click and docker please see the [installation](./installation) guides.
|
||||
Manual guides for deployment on various platforms, for One-click and docker please see the [installation](../getting-started/installation.md) guides.
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/amazon-aws">
|
||||
<InstallLink link="../deployment/amazon-aws.html">
|
||||
<template #icon>
|
||||
<svg width="64" height="64" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><g fill="#fff" fill-rule="evenodd"><path d="M15.63 31.388l-7.135-2.56V18.373l7.135 2.43zm1.3 0l7.135-2.56V18.373l-7.135 2.432zm-7.7-13.8l7.2-2.033 6.696 2.16-6.696 2.273zm-2.092-.8L0 14.22V3.75l7.135 2.43zm1.307 0l7.135-2.56V3.75L8.443 6.192zm-7.7-13.8l7.2-2.043 6.696 2.16-6.696 2.273zm23.052 13.8l-7.135-2.56V3.75l7.135 2.43zm1.3 0l7.135-2.56V3.75l-7.135 2.43zm-7.7-13.8l7.2-2.033 6.696 2.16-6.696 2.273z" fill-rule="nonzero"></path></g></svg>
|
||||
</template>
|
||||
@ -23,7 +23,7 @@ Manual guides for deployment on various platforms, for One-click and docker plea
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/azure">
|
||||
<InstallLink link="../deployment/azure.html">
|
||||
<template #icon>
|
||||
<svg width="100" height="77.43" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.68 15.24"><path d="M9.105 14.43l4.642-.82.043-.01-2.387-2.84a403.945 403.945 0 0 1-2.387-2.853c0-.014 2.465-6.802 2.479-6.826.004-.008 1.682 2.888 4.066 7.02l4.09 7.09.031.054-7.587-.001-7.587-.001 4.597-.812zM0 13.566c0-.004 1.125-1.957 2.5-4.34L5 4.893l2.913-2.445C9.515 1.104 10.83.002 10.836 0a.512.512 0 0 1-.047.118L7.625 6.903l-3.107 6.663-2.259.003c-1.242.002-2.259 0-2.259-.004z" fill="#fff"/></svg>
|
||||
</template>
|
||||
@ -35,7 +35,7 @@ Manual guides for deployment on various platforms, for One-click and docker plea
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/digitalocean">
|
||||
<InstallLink link="../deployment/digitalocean.html">
|
||||
<template #icon>
|
||||
<svg width="178" height="177" viewBox="0 0 178 177" xmlns="http://www.w3.org/2000/svg"><g fill="#fff" fill-rule="evenodd"><path d="M89 176.5v-34.2c36.2 0 64.3-35.9 50.4-74-5.1-14-16.4-25.3-30.5-30.4-38.1-13.8-74 14.2-74 50.4H.8C.8 30.6 56.6-14.4 117.1 4.5c26.4 8.3 47.5 29.3 55.7 55.7 18.9 60.5-26.1 116.3-83.8 116.3z" fill-rule="nonzero"></path><path d="M89.1 142.5H55v-34.1h34.1zM55 168.6H28.9v-26.1H55zM28.9 142.5H7v-21.9h21.9v21.9z"></path></g></svg>
|
||||
</template>
|
||||
@ -47,7 +47,7 @@ Manual guides for deployment on various platforms, for One-click and docker plea
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/google-app-engine">
|
||||
<InstallLink link="../deployment/google-app-engine.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" version="1.1"><path d="M6.969 3L4.094 8.188l1.468 2.624L8.438 6h10.25L17 3zm8.75 4l2.969 4.906L13.625 21H17l5-9-2.781-5zM12 8c-2.207 0-4 1.793-4 4s1.793 4 4 4 4-1.793 4-4-1.793-4-4-4zM3.531 9.219L2 12l4.969 9H12.5l1.656-3h-5.75zM12 10c1.102 0 2 .898 2 2 0 1.102-.898 2-2 2-1.102 0-2-.898-2-2 0-1.102.898-2 2-2z" fill="#fff"/></svg>
|
||||
</template>
|
||||
@ -59,7 +59,7 @@ Manual guides for deployment on various platforms, for One-click and docker plea
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/heroku">
|
||||
<InstallLink link="../deployment/heroku.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 5.12 5.12" preserveAspectRatio="xMinYMin meet"><path d="M3.068 4.415V2.382s.132-.487-1.63.2C1.436 2.6 1.436.7 1.436.7L2.01.697v1.2s1.61-.635 1.61.48v2.026h-.555zm.328-2.986h-.6c.22-.27.42-.73.42-.73h.63s-.108.3-.44.73zm-1.95 2.982V3.254l.58.58-.58.58z" fill="#fff"/></svg>
|
||||
</template>
|
||||
@ -75,7 +75,7 @@ Manual guides for deployment on various platforms, for One-click and docker plea
|
||||
Additional guides for optional software additions that compliment or improve the deployment process when using Strapi in a production or production-like environment.
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/caddy-proxy">
|
||||
<InstallLink link="../deployment/caddy-proxy.html">
|
||||
<template #icon>
|
||||
<img src="../assets/deployment/caddy-monotone.svg"/>
|
||||
</template>
|
||||
@ -87,7 +87,7 @@ Additional guides for optional software additions that compliment or improve the
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/haproxy-proxy">
|
||||
<InstallLink link="../deployment/haproxy-proxy.html">
|
||||
<template #icon>
|
||||
HAP
|
||||
</template>
|
||||
@ -99,7 +99,7 @@ Additional guides for optional software additions that compliment or improve the
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../deployment/nginx-proxy">
|
||||
<InstallLink link="../deployment/nginx-proxy.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="-35.5 26 32 32" width="64" height="64"><path d="M-33.442 42.023v-7.637a.68.68 0 0 1 .385-.651l13.173-7.608c.237-.148.503-.178.74-.03l13.232 7.637a.71.71 0 0 1 .355.651V49.63a.71.71 0 0 1-.355.651l-11.367 6.57a56.27 56.27 0 0 1-1.806 1.036c-.266.148-.533.148-.8 0l-13.202-7.608c-.237-.148-.355-.326-.355-.622v-7.637z" fill="#fff"/><path d="M-24.118 39.18v8.9c0 1.006-.8 1.894-1.865 1.865-.65-.03-1.154-.296-1.5-.858-.178-.266-.237-.562-.237-.888V35.836c0-.83.503-1.42 1.154-1.687s1.302-.207 1.954 0c.622.178 1.095.562 1.5 1.036l7.874 9.443c.03.03.06.09.118.148v-9c0-.947.65-1.687 1.57-1.776 1.154-.148 1.924.68 2.042 1.54v12.6c0 .7-.326 1.214-.918 1.54-.444.237-.918.296-1.42.266a3.23 3.23 0 0 1-1.954-.829c-.296-.266-.503-.592-.77-.888l-7.49-8.97c0-.03-.03-.06-.06-.09z" fill="#3498DB"/></svg>
|
||||
</template>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
### Installation guides
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/cli">
|
||||
<InstallLink link="../installation/cli.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 271"><g><path d="M116.553,0 L0,67.953 L0,98.096 L49.665,127.882 L91.366,105.163 L91.366,78.74 L179.665,28.034 L241.711,63.77 L241.637,135.222 L156.567,184.231 L128.082,173.694 L90.165,197.882 L91.128,255.785 L117.233,270.858 L234.743,203.897 L234.743,163.65 L221.531,170.761 L221.531,196.347 L117.267,255.461 L104.352,248.005 L103.644,205.48 L128.114,189.128 L157.607,199.658 L256,142.912 L255.065,55.656 L179.678,12.633 L78.016,71.009 L78.016,97.419 L49.824,112.41 L13.35,90.536 L13.35,75.622 L116.243,15.636 L137.841,29.399 L150.89,21.886 L116.553,0 Z M186.0696,71.0918 L164.1876,84.3678 L164.7436,109.9558 L187.1816,122.2678 L209.0636,108.9918 L208.5076,83.4048 L186.0696,71.0918 Z M186.3206,82.6508 L198.6226,89.4018 L198.9276,103.4308 L186.9306,110.7088 L174.6286,103.9588 L174.3236,89.9298 L186.3206,82.6508 Z M73.701,141.0235 L70.738,135.4095 C70.086,134.1755 68.558,133.7035 67.324,134.3545 L47.931,144.5855 C46.697,145.2365 46.224,146.7655 46.876,148.0005 L49.84,153.6175 C50.491,154.8515 52.02,155.3245 53.254,154.6725 L72.645,144.4385 C73.88,143.7865 74.352,142.2575 73.701,141.0235 M84.9168,158.0703 L81.9548,152.4543 C81.2838,151.1813 79.6868,150.7253 78.4438,151.4513 L45.7398,170.5723 C44.5718,171.2563 44.1488,172.7373 44.7798,173.9333 L47.7418,179.5493 C48.4138,180.8223 50.0108,181.2783 51.2528,180.5523 L83.9578,161.4313 C85.1248,160.7483 85.5478,159.2673 84.9168,158.0703 M87.9705,169.6055 L49.5225,191.7065 C48.3435,192.3835 47.9115,193.8735 48.5475,195.0765 L51.5105,200.6915 C52.1785,201.9575 53.7635,202.4165 55.0045,201.7035 L93.4525,179.6025 C94.6325,178.9245 95.0635,177.4345 94.4285,176.2315 L91.4645,170.6165 C90.7965,169.3515 89.2115,168.8925 87.9705,169.6055" fill="#FFF"/></g></svg>
|
||||
</template>
|
||||
@ -15,7 +15,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/docker">
|
||||
<InstallLink link="../installation/docker.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="34" height="23"><g fill="#fff" fill-rule="evenodd"><path d="M18.8017 10.5442h3.4333v-3.101h-3.4333zM14.745 10.5442h3.4333v-3.101H14.745v3.101zM10.6892 10.5442h3.4325v-3.101h-3.4334v3.101zM6.6316 10.5442h3.4334v-3.101H6.6316zM2.5759 10.5442h3.4324v-3.101H2.576v3.101zM6.6326 6.8226h3.4324v-3.101H6.6316v3.101zM10.6892 6.8226h3.4325v-3.101h-3.4334v3.101zM14.745 6.8226h3.4333v-3.101H14.745v3.101zM14.745 3.101h3.4333V0H14.745v3.101z"></path><path d="M28.752 8.3043c-.1708-1.2412-.8667-2.317-2.1326-3.2901l-.727-.482-.4866.7243c-.6197.9309-.9318 2.2216-.829 3.46.046.4351.19 1.2145.6408 1.8993-.4498.2405-1.3366.572-2.5144.549H.1285l-.045.2589c-.2111 1.2439-.2075 5.1252 2.329 8.1087 1.9269 2.2675 4.8168 3.4178 8.5889 3.4178 8.1757 0 14.2245-3.741 17.0565-10.5406 1.1136.022 3.5132.0064 4.7461-2.3326.0312-.0533.1056-.1947.3204-.638l.1184-.2424-.693-.46c-.75-.4984-2.4723-.681-3.7979-.4323z"></path></g></svg>
|
||||
</template>
|
||||
@ -27,7 +27,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/digitalocean-one-click">
|
||||
<InstallLink link="../installation/digitalocean-one-click.html">
|
||||
<template #icon>
|
||||
<svg width="178" height="177" viewBox="0 0 178 177" xmlns="http://www.w3.org/2000/svg"><g fill="#fff" fill-rule="evenodd"><path d="M89 176.5v-34.2c36.2 0 64.3-35.9 50.4-74-5.1-14-16.4-25.3-30.5-30.4-38.1-13.8-74 14.2-74 50.4H.8C.8 30.6 56.6-14.4 117.1 4.5c26.4 8.3 47.5 29.3 55.7 55.7 18.9 60.5-26.1 116.3-83.8 116.3z" fill-rule="nonzero"></path><path d="M89.1 142.5H55v-34.1h34.1zM55 168.6H28.9v-26.1H55zM28.9 142.5H7v-21.9h21.9v21.9z"></path></g></svg>
|
||||
</template>
|
||||
@ -39,7 +39,7 @@
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<InstallLink link="../installation/platformsh">
|
||||
<InstallLink link="../installation/platformsh.html">
|
||||
<template #icon>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><defs><style>.bcac695a-a0a4-4100-84fd-61ecc421091c{fill:#0a0a0a;}.fc8dd422-fb02-4822-a57e-c20c8b5eef7c{fill:#fff;}</style></defs><g id="b5f9bb49-1614-4b22-8c04-f5182c1803f5" data-name="Layer 2"><g id="b2a28560-5e48-4435-accd-e149b4f96cc0" data-name="Layer 1"><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="10.72" width="28.55" height="11.35"/><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="35.42" width="28.55" height="3.86"/><rect class="fc8dd422-fb02-4822-a57e-c20c8b5eef7c" x="10.73" y="25.74" width="28.55" height="5.82"/></g></g></svg>
|
||||
</template>
|
||||
@ -52,4 +52,4 @@
|
||||
|
||||
### Deployment guides
|
||||
|
||||
For a more detailed overview of deployment please see the [related documentation](./deployment).
|
||||
For a more detailed overview of deployment please see the [related documentation](./deployment.md).
|
||||
|
||||
@ -8,7 +8,7 @@ Get ready to get Strapi up and running in **less than 5 minutes** 🚀.
|
||||
|
||||
_For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.md)._
|
||||
|
||||
(Before continuing, please make sure [Node.js and npm are properly installed](install-requirements.md) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).)
|
||||
(Before continuing, please make sure [Node.js and npm are properly installed](../installation/cli.html#step-1-make-sure-requirements-are-met) on your machine. You can [install the Yarn v1.2.0+ package here](https://yarnpkg.com/en/).)
|
||||
|
||||
## 1. Install Strapi and Create a new project
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ But we don't want to use [parameters](../content-api/parameters.md) (eg. /articl
|
||||
|
||||
To be able to do that, you have first to understand some concepts.
|
||||
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/endpoint.md).
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/api-endpoints.md).
|
||||
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controller.md) that exist by default when a content type is created.
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controllers.md) that exist by default when a content type is created.
|
||||
|
||||
If you check the controller file of your generated API `./api/{content-type}/controller/{Content-Type}.js`, you will see an empty file. It is because all the default logic is managed by Strapi. But you can override these actions with your own code.
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ What we want here is to add some custom logic and call the email service when a
|
||||
|
||||
To be able to do that, you have first to understand some concepts.
|
||||
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/endpoint.md).
|
||||
When you create a content type, it generates an API with the following list of [endpoints](../content-api/api-endpoints.md).
|
||||
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controller.md) that exist by default when a content type is created.
|
||||
Each of these endpoint triggers a controller action. Here is the list of [controller actions](../concepts/controllers.md) that exist by default when a content type is created.
|
||||
|
||||
If you check the controller file of your generated API `./api/{content-type}/controller/{Content-Type}.js`, you will see an empty file. It is because all the default logic is managed by Strapi. But you can override these actions with your own code.
|
||||
|
||||
|
||||
@ -96,7 +96,7 @@ The whole file will look like this:
|
||||
### Strapi instance
|
||||
|
||||
In order to test anything we need to have a strapi instance that runs in the testing eviroment,
|
||||
bascially we want to get instance of strapi app as object, similar like creating an instance for [process manager](process-manager).
|
||||
bascially we want to get instance of strapi app as object, similar like creating an instance for [process manager](process-manager.md).
|
||||
|
||||
These tasks require adding some files - let's create a folder `tests` where all the tests will be put and inside it, next to folder `helpers` where main Strapi helper will be in file strapi.js.
|
||||
|
||||
@ -135,13 +135,13 @@ const fs = require('fs');
|
||||
const { setupStrapi } = require('./helpers/strapi');
|
||||
|
||||
/** this code is called once before any test is called */
|
||||
beforeAll(async (done) => {
|
||||
beforeAll(async done => {
|
||||
await setupStrapi(); // singleton so it can be called many times
|
||||
done();
|
||||
});
|
||||
|
||||
/** this code is called once before all the tested are finished */
|
||||
afterAll(async (done) => {
|
||||
afterAll(async done => {
|
||||
const dbSettings = strapi.config.get('database.connections.default.settings');
|
||||
|
||||
//delete test database after all tests
|
||||
@ -154,7 +154,7 @@ afterAll(async (done) => {
|
||||
done();
|
||||
});
|
||||
|
||||
it('strapi is defined', async (done) => {
|
||||
it('strapi is defined', async done => {
|
||||
expect(strapi).toBeDefined();
|
||||
done();
|
||||
});
|
||||
@ -193,11 +193,11 @@ Let's create a separate test file were `supertest` will be used to check if endp
|
||||
```js
|
||||
const request = require('supertest');
|
||||
|
||||
it('should return hello world', async (done) => {
|
||||
it('should return hello world', async done => {
|
||||
await request(strapi.server) // app server is an instance of Class: http.Server
|
||||
.get('/hello')
|
||||
.expect(200) // Expect response http code 200
|
||||
.then((data) => {
|
||||
.then(data => {
|
||||
expect(data.text).toBe('Hello World!'); // expect the response text
|
||||
});
|
||||
done();
|
||||
@ -251,7 +251,7 @@ const mockUserData = {
|
||||
blocked: null,
|
||||
};
|
||||
|
||||
it('should login user and return jwt token', async (done) => {
|
||||
it('should login user and return jwt token', async done => {
|
||||
/** Creates a new user and save it to the database */
|
||||
await strapi.plugins['users-permissions'].services.user.add({
|
||||
...mockUserData,
|
||||
@ -267,14 +267,14 @@ it('should login user and return jwt token', async (done) => {
|
||||
})
|
||||
.expect('Content-Type', /json/)
|
||||
.expect(200)
|
||||
.then((data) => {
|
||||
.then(data => {
|
||||
expect(data.body.jwt).toBeDefined();
|
||||
});
|
||||
|
||||
done();
|
||||
});
|
||||
|
||||
it('should return users data for authenticated user', async (done) => {
|
||||
it('should return users data for authenticated user', async done => {
|
||||
/** Gets the default user role */
|
||||
const defaultRole = await strapi.query('role', 'users-permissions').findOne({}, []);
|
||||
|
||||
@ -299,7 +299,7 @@ it('should return users data for authenticated user', async (done) => {
|
||||
.set('Authorization', 'Bearer ' + jwt)
|
||||
.expect('Content-Type', /json/)
|
||||
.expect(200)
|
||||
.then((data) => {
|
||||
.then(data => {
|
||||
expect(data.body).toBeDefined();
|
||||
expect(data.body.id).toBe(user.id);
|
||||
expect(data.body.username).toBe(user.username);
|
||||
|
||||
@ -55,7 +55,7 @@ Then, delete your old `plugins` folder and replace it with the new one.
|
||||
|
||||
## ⚠️ Bookshelf (Postgres and MySQL)
|
||||
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15) Bookshelf section.
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15.md) Bookshelf section.
|
||||
|
||||
Go in [diff files](https://github.com/strapi/strapi/compare/v3.0.0-alpha.15...v3.0.0-alpha.16) and search for following files:
|
||||
|
||||
@ -68,7 +68,7 @@ You will have to update all your service by applying the diff.
|
||||
|
||||
## ⚠️ Mongoose (Mongo)
|
||||
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15) Mongoose section.
|
||||
Reverse of migration [alpha.14.5 to alpha.15](migration-guide-alpha.14.5-to-alpha.15.md) Mongoose section.
|
||||
|
||||
Go in [diff files](https://github.com/strapi/strapi/compare/v3.0.0-alpha.15...v3.0.0-alpha.16) and search for following files:
|
||||
|
||||
|
||||
@ -84,7 +84,7 @@ module.exports = ({ env }) => ({
|
||||
```
|
||||
|
||||
::: tip
|
||||
If you're using a different provider depending on your environment, you can specify the correct configuration in `config/env/${yourEnvironment}/plugins.js`. More info here: [Environments](../concepts/configurations#environments)
|
||||
If you're using a different provider depending on your environment, you can specify the correct configuration in `config/env/${yourEnvironment}/plugins.js`. More info here: [Environments](../concepts/configurations.md#environments)
|
||||
:::
|
||||
|
||||
## Create new provider
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# GraphQL
|
||||
|
||||
By default Strapi create [REST endpoints](../content-api/api-endpoints) for each of your content types. With the GraphQL plugin, you will be able to add a GraphQL endpoint to fetch and mutate your content.
|
||||
By default Strapi create [REST endpoints](../content-api/api-endpoints.md) for each of your content types. With the GraphQL plugin, you will be able to add a GraphQL endpoint to fetch and mutate your content.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user