2018-01-10 11:32:24 +01:00
# Quick start
2019-11-07 12:05:39 +01:00
To facilitate the development of a plugin, we drastically reduce the amount of commands necessary to install the entire development environment. Before getting started, you need to have Node.js (v8) and npm (v5) installed.
2018-01-10 11:32:24 +01:00
## Development Environment Setup
To setup the development environment please **follow the instructions below:**
1. [Fork the repository ](https://github.com/strapi/strapi ) to your own GitHub account.
2018-12-14 15:38:37 -05:00
2. Clone it to your computer `git clone git@github.com:strapi/strapi.git` . (or your fork)
3. Run `cd strapi && npm run setup`
2018-01-10 11:32:24 +01:00
2018-10-01 12:19:34 +02:00
You can run `npm run setup:build` to build the plugins' admin (the setup time will be longer)
2018-04-17 11:49:09 +02:00
2018-12-14 15:38:37 -05:00
Create a development project
1. Create a new project `cd .. && strapi new myDevelopmentProject --dev` .
2. `cd myDevelopmentProject && strapi start` To start the strapi project
2019-11-07 12:05:39 +01:00
::: tip
2018-10-01 12:19:34 +02:00
If the installation failed, please remove the global packages related to Strapi. The command `npm ls strapi` will help you to find where your packages are installed globally.
:::
2018-01-10 11:32:24 +01:00
## Plugin development Setup
2018-12-14 15:38:37 -05:00
In a new terminal window:
1. Generate a new plugin: `cd /path/to/myDevelopmentProject && strapi generate:plugin my-plugin`
2019-01-30 10:51:44 +01:00
2. Install admin dependencies and build: `cd /admin && npm run setup`
2018-12-14 15:38:37 -05:00
3. `npm start`
When finished with plugin modifications:
1. `cd /path/to/myDevelopmentProject && npm run setup ---plugins`
2018-01-10 11:32:24 +01:00
2018-12-14 15:38:37 -05:00
To rebuild plugins:
2018-01-10 11:32:24 +01:00
2018-12-14 15:38:37 -05:00
Run this inside the cloned or forked repo of `strapi`
2018-01-10 11:32:24 +01:00
2019-11-07 12:05:39 +01:00
1. `cd strapi && npm run setup:build`
2018-01-10 11:32:24 +01:00
2018-12-14 15:38:37 -05:00
Your are now ready to develop your own plugin and live-test your updates! The working local URI should be localhost:4000/admin.