fix: Added docs package as part or the monorepo and simplified depend…

…encies (#44)

* Added docs

* fix: dependencies to minimize the size of the package

* Added docs package as part or the monorepo

.dockerignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -1,4 +1,2 @@
 # Bloc
-Building blocks for a functional Reactjs UI built with styled-system
-
-This is a mono-repo for `@pindoio/blocjs packages`
+Monorepo containing both `blocjs` and `doc` site

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3.8'
+
+services:
+  docs:
+    tty: true
+    restart: always
+    stdin_open: true
+    container_name: blocjs_docs
+    command: yarn start
+    env_file: ./packages/docs/.env
+    build:
+      context: .
+      dockerfile: ./packages/docs/Dockerfile
+    volumes:
+      - './packages/docs:/home/blocjs/packages/docs'
+    ports:
+      - 2000:2000

package.json

@@ -5,10 +5,6 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@testing-library/react": "10.3.0",
-    "jest": "^26.0.1",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
     "semantic-release": "^17.0.8",
     "semantic-release-monorepo": "^7.0.2"
   },

packages/blocjs/README.md

@@ -1,17 +1,21 @@
 # Bloc
-Blocjs is a minimal structural set of components built for React using Styled System
+Blocjs is a minimal set of components built for ReactJS using Styled System.
+With an intent to separate structural from visual components.
+
+
+## Peer dependencies
+For this library to work you have to install `ReactJS`
 
 ## Installation
 You can install blocjs with a specific version on get the latest as shown below
 ```sh
-yarn add @pindoio/blocjs
+yarn add blocjs styled-components
 ```
 or
 ```sh
-npm i @pindoio/blocjs
+npm i blocjs styled-components
 ```
 
-
 ## Flex
 Flex purpose is to create a non-visual structural component
 which influence its children behaviour using flexbox specifications.
@@ -20,12 +24,9 @@ which influence its children behaviour using flexbox specifications.
 Normally box can be used everywhere. But works better within the Flex component
 Similary to Flex, Box is non-visual structural component.
 
-## Hide
-Hide has alot in common with box with extra ability to be hidden on certain breakpoints. 
-
-## Border
-Border is the only visual component.
+## Bloc
+Bloc is the only visual component.
 Similar to box it have properties to show its border and background.
 
-# Use cases
-Coming soon
+## Hide
+Hide has alot in common with box with extra ability to be hidden on certain breakpoints. 

packages/blocjs/package.json

@@ -10,7 +10,6 @@
     "build": "webpack --mode production"
   },
   "dependencies": {
-    "styled-components": "^5.1.1",
     "@styled-system/css": "^5.1.5",
     "styled-system": "^5.1.5"
   },
@@ -22,13 +21,11 @@
     "webpack": "^4.43.0",
     "webpack-cli": "^3.3.12",
     "webpack-node-externals": "^1.7.2",
-    "react-is": "^16.13.1",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1"
+    "styled-components": "^5.1.1"
   },
   "peerDependencies": {
     "react": "^16.13.1",
-    "react-dom": "^16.13.1"
+    "styled-components": "^5.1.1"
   },
     "repository": {
     "type": "git",

packages/docs/.dockerignore

@@ -0,0 +1 @@
+node_modules

packages/docs/.env

@@ -0,0 +1,2 @@
+PORT=2000
+SKIP_PREFLIGHT_CHECK=true

packages/docs/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

packages/docs/Dockerfile

@@ -0,0 +1,18 @@
+FROM node:14.4-alpine
+
+WORKDIR /home/blocjs
+COPY ./package.json .
+COPY ./packages ./packages
+
+RUN addgroup -S blocjsgroup
+RUN adduser -S -D -h /home/blocjs blocjs blocjsgroup
+RUN chown -R blocjs:blocjsgroup /home/blocjs
+USER blocjs
+
+RUN yarn workspace blocjs install
+RUN yarn workspace docs install
+
+WORKDIR /home/blocjs/packages/docs
+
+EXPOSE ${PORT}
+CMD ["yarn", "start"]

packages/docs/README.md

@@ -0,0 +1,68 @@
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `yarn build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

packages/docs/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "docs",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-scripts": "3.4.1"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}

packages/docs/public/index.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

packages/docs/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

packages/docs/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

packages/docs/src/App.css

@@ -0,0 +1,38 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  height: 40vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .App-logo {
+    animation: App-logo-spin infinite 20s linear;
+  }
+}
+
+.App-header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}

packages/docs/src/App.js

@@ -0,0 +1,17 @@
+import React from "react";
+import { ThemeProvider } from "styled-components";
+import { Bloc } from "blocjs";
+
+import theme from "./theme";
+
+const App = () => {
+  return (
+    <ThemeProvider theme={theme}>
+      <Bloc color="primaryDark">Bloc</Bloc>
+      <Bloc color="primary">BlocJS</Bloc>
+      <Bloc color="primaryLight">BlocJS Library</Bloc>
+    </ThemeProvider>
+  );
+};
+
+export default App;

packages/docs/src/App.test.js

@@ -0,0 +1,9 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+import App from './App';
+
+test('renders learn react link', () => {
+  const { getByText } = render(<App />);
+  const linkElement = getByText(/learn react/i);
+  expect(linkElement).toBeInTheDocument();
+});