|
3 | 3 | Statamic Starter Kit: Doogie Browser |
4 | 4 | </h1> |
5 | 5 |
|
6 | | - |
| 6 | + |
| 7 | + |
| 8 | +> View on the [Statamic Marketplace](https://statamic.com/starter-kits/statamic/doogie-browser)! |
7 | 9 | <!-- /statamic:hide --> |
| 10 | +
|
8 | 11 | ## Features |
9 | 12 | - Articles blogging collection with homepage listing |
10 | 13 | - Markdown focused writing experience |
|
19 | 22 | - [PurgeCSS](https://purgecss.com/) for that tiny `4kb` css file size |
20 | 23 | - :100: Lighthouse score |
21 | 24 |
|
22 | | -<!-- statamic:hide --> |
23 | | -## Screenshot |
24 | | - |
25 | | - |
26 | 25 |
|
27 | | -## Video Tour |
28 | | - |
29 | | -Watch the [Doogie Browser video tour](https://www.youtube.com/watch?v=-cLzCWu-DeE) to see what's going on under the hood. |
30 | | -<!-- /statamic:hide --> |
31 | 26 | ## Quick Start |
32 | 27 |
|
33 | | -**1. Create a new site** cloning the repo and removing the origin repo. |
| 28 | +### Install as a New Site |
| 29 | +You can spin up a new install of Statamic along with this Starter Kit all in one command by using the [Statamic CLI Tool](https://github.com/statamic/cli) |
34 | 30 |
|
35 | 31 | ``` |
36 | | -git clone [email protected]:statamic/starter-kit-doogie-browser.git diary |
37 | | -cd diary |
38 | | -rm -rf .git |
39 | | -composer install |
40 | | -cp .env.example .env && php artisan key:generate |
| 32 | +statamic new mysite statamic/starter-kit-starters-creek |
41 | 33 | ``` |
42 | 34 |
|
43 | | -**2. Make a new user** – you'll want it to be a `super` so you have access to everything. |
| 35 | +Follow the prompts and you'll be up and running shortly. |
| 36 | + |
| 37 | +### Install into an existing site |
| 38 | +You can alternatively install Starter Kits into an existing Statamic 3.2+ site by running the following command while inside that install's root directory: |
44 | 39 |
|
45 | 40 | ``` |
46 | | -php please make:user |
| 41 | +php please starter-kit:install statamic/starter-kit-starters-creek |
47 | 42 | ``` |
48 | 43 |
|
49 | | -**3. Recompile the CSS** (optional) |
50 | 44 |
|
51 | | -The [TailwindCSS](https://tailwindcss.com/) included in this kit is compiled with [PurgeCSS](https://purgecss.com/) to reduce filesize on any unused classes and selectors. If you want to modify anything, just recompile it. |
| 45 | +### Customizing (optional) |
| 46 | + |
| 47 | +The [TailwindCSS](https://tailwindcss.com/) included in this kit is compiled with [PurgeCSS](https://purgecss.com/) to reduce filesize on any unused classes and selectors. If you want to modify anything you'll need to recompile it. |
52 | 48 |
|
53 | 49 | ``` |
54 | 50 | npm i && npm run dev |
55 | 51 | ``` |
56 | 52 |
|
57 | 53 | To compile for production again: |
| 54 | + |
58 | 55 | ``` |
59 | 56 | npm run production |
60 | 57 | ``` |
61 | 58 |
|
62 | | -**4. Do your thing!** |
63 | | - |
64 | | -If you're using [Laravel Valet](https://laravel.com/docs/valet) (or similar), your site should be available at `http://diary.test`. You can access the control panel at `http://diary.test/cp` and login with your new user. Open up the source code, follow along with the [Statamic 3 docs](https://statamic.dev), and enjoy! |
65 | | - |
66 | 59 | ## Contributing |
67 | 60 |
|
68 | 61 | Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](https://github.com/statamic/cms/wiki/Code-of-Conduct). |
0 commit comments