feat: bootstrap

Author: FabienGreard

.env .env.example

@@ -1,5 +1,5 @@
 {
-  "extends": ["next/core-web-vitals", "prettier", "plugin:@next/next/recommended"],
+  "extends": ["next/core-web-vitals", "prettier"],
   "rules": {
     "import/no-anonymous-default-export": 0
   }

.eslintrc.json

@@ -54,22 +54,13 @@ yarn-debug.log*
 yarn-error.log*
 
 # local env files
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+.env
 
 # vercel
 .vercel
 
 # vscode
 *.code-workspace
 
-# apollo
-graphql-schema.json
-
-# prisma
-prisma/migrations
-
 # lhci
 .lighthouseci

.gitignore

@@ -21,9 +21,13 @@ You should, with this boilerplate only focus on coding rocking react components!
 
 Start by cloning this repository, then use either `yarn install` or `npm install` to download the dependencies.
 
+## Quick start
+
+Want an easy way yo start the project with everything setup ? launch `yarn bootstrap` or `npm run bootstrap`
+
 ## Getting Started
 
-First look at the `.env` file. (you can start with the default)
+First look at the `.env.example` file. (you can start with the default) by copying it into `.env`.
 
 Then, run the development server:
 
@@ -39,6 +43,7 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the
 
 | Commands        |                      Info                       |                                                                Description |
 | --------------- | :---------------------------------------------: | -------------------------------------------------------------------------: |
+| bootstrap       |            node scripts/bootstrap.js            |                                                  run and setup the project |
 | dev             |                    next dev                     |                                                     Launch app in dev mode |
 | dev:test        |                  jest --watch                   |                                                                Launch test |
 | dev:coverage    |             jest --coverage --watch             |                                              Generate a coverage from test |
@@ -127,11 +132,13 @@ At this point your should be able to execute `yarn prisma:migrate` or `npm run p
 
 You could also seed your database with `yarn prisma:seed` or `npm run prisma:seed`.
 
+:warning: by default you wont have the access for doing it, use your own database.
+
 ## Generate typing from graphql schema
 
 You may need to look at [apollo-tooling](https://github.com/apollographql/apollo-tooling)
 
-With the graphql endpoint running launch `yarn codegen`, this will create under `types` a typing file for each query under `apollo/operations`.
+With the graphql endpoint running launch `yarn codegen`, this will create a typing file `schema.ts` under `types`.
 
 ## Hosting
 
@@ -146,6 +153,7 @@ Kirby use [vercel](https://vercel.com/docs) however you can use any other hostin
   - [ ] Monorepo
   - [ ] Without server / api (remove apollo)
   - [ ] More installer ??
+- [ ] improve changelog generation
 - [ ] Better doc ?
 - [ ] Feature projects build with Kirby
 - [ ] Feature contributors

README.md

@@ -26,6 +26,7 @@
     "github-actions"
   ],
   "scripts": {
+    "bootstrap": "node scripts/bootstrap.js",
     "dev": "next dev",
     "dev:test": "jest --watch",
     "dev:coverage": "jest --coverage --watch",

package.json

@@ -0,0 +1,23 @@
+const { join } = require('path');
+const exec = require('./exec');
+const fs = require('fs');
+
+(async () => {
+  console.log(
+    `%c 
+    ██╗  ██╗██╗██████╗ ██████╗ ██╗   ██╗     ██████╗  ██████╗ ██╗██╗     ███████╗██████╗ ██████╗ ██╗      █████╗ ████████╗███████╗
+    ██║ ██╔╝██║██╔══██╗██╔══██╗╚██╗ ██╔╝     ██╔══██╗██╔═══██╗██║██║     ██╔════╝██╔══██╗██╔══██╗██║     ██╔══██╗╚══██╔══╝██╔════╝
+    █████╔╝ ██║██████╔╝██████╔╝ ╚████╔╝█████╗██████╔╝██║   ██║██║██║     █████╗  ██████╔╝██████╔╝██║     ███████║   ██║   █████╗  
+    ██╔═██╗ ██║██╔══██╗██╔══██╗  ╚██╔╝ ╚════╝██╔══██╗██║   ██║██║██║     ██╔══╝  ██╔══██╗██╔═══╝ ██║     ██╔══██║   ██║   ██╔══╝  
+    ██║  ██╗██║██║  ██║██████╔╝   ██║        ██████╔╝╚██████╔╝██║███████╗███████╗██║  ██║██║     ███████╗██║  ██║   ██║   ███████╗
+    ╚═╝  ╚═╝╚═╝╚═╝  ╚═╝╚═════╝    ╚═╝        ╚═════╝  ╚═════╝ ╚═╝╚══════╝╚══════╝╚═╝  ╚═╝╚═╝     ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝   
+    `,
+    'font-family:monospace',
+  );
+  await exec('yarn clear', { echo: true });
+  await exec('yarn install', { echo: true });
+  if (!fs.existsSync(join(__dirname, '/../.env'))) {
+    await exec(`cp ${join(__dirname, '/../.env.example')} ${join(__dirname, '/../.env')}`, { echo: true });
+  }
+  await exec('yarn dev', { echo: true });
+})();

scripts/bootstrap.js

@@ -5,9 +5,9 @@ const exec = require('./exec');
 (async () => {
   console.log('--- CLEAR ---');
   await Promise.all([
-    exec('rm', ['-rf', `${join(__dirname, '/../node_modules')}`], { echo: true }),
-    exec('rm', ['-rf', `${join(__dirname, '/../*lock*')}`], { echo: true }),
-    exec('rm', ['-rf', `${join(__dirname, '/.next')}`], { echo: true }),
+    exec(`rm -rf ${join(__dirname, '/../node_modules')}`, { echo: true }),
+    exec(`rm -rf ${join(__dirname, '/../*lock*')}`, { echo: true }),
+    exec(`rm -rf ${join(__dirname, '/.next')}`, { echo: true }),
   ]);
   console.log('--- DONE ---');
 })();

scripts/clear.js

@@ -1,20 +1,24 @@
-/* eslint-disable no-console */
-const { spawn } = require('child_process');
+const { spawn, exec } = require('child_process');
+const os = require('os');
 
-module.exports = (command, args, { capture = false, echo = false } = {}) => {
-  if (echo) console.log(command, ...args);
+module.exports = (command, { capture = false, echo = false } = {}) => {
+  if (echo) {
+    console.log(command);
+  }
 
-  const childProcess = spawn(command, args, { stdio: capture ? 'pipe' : 'inherit' });
+  const childProcess =
+    os.platform() === 'win32' ? exec(command) : spawn('bash', ['-c', command], { stdio: capture ? 'pipe' : 'inherit' });
 
   return new Promise((resolve, reject) => {
     let stdout = '';
 
-    if (capture)
+    if (capture) {
       childProcess.stdout.on('data', data => {
         stdout += data;
       });
+    }
 
-    childProcess.on('error', error => reject(new Error(error)));
+    childProcess.on('error', error => reject(new Error({ code: 1, error })));
 
     childProcess.on('close', code =>
       code > 0