Add documentation site

devisle · Feb 7, 2020 · 854b7b2 · 854b7b2
1 parent 03bcd89
commit 854b7b2
Show file tree

Hide file tree

Showing 7 changed files with 149 additions and 2 deletions.
diff --git a/doc/README.md → CHECKLIST.md b/doc/README.md → CHECKLIST.md
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@
 - [Packages](#packages)
 - [Running tests](#running-tests)
 - [Contributing](CONTRIBUTING.md)
-- [Development Checklist](https://github.com/devisle/advanced-react-cli/tree/master/doc)
+- [Development Checklist](CHECKLIST.md)
 - [What does this do?](#what-does-this-do)
 - [FAQs](#faqs)
 - [Dev Isle community](#dev-isle-community)
@@ -116,7 +116,7 @@ We are continuously working on improving the CLI. But, as of this current stable
 1. How can I test this out?
 
 - If you'd like to try it out , Run the following command `npx advanced-react-cli` in your terminal.
-- We are still continuing to work on our [Development Checklist](https://github.com/devisle/advanced-react-cli/tree/master/doc).
+- We are still continuing to work on our [Development Checklist](CHECKLIST.md).
 
 - Ensure you have git version control, and package manager - either npm (node package manager) or Yarn Installed. You may check if your system has them installed by running the following commands `git --version` and depending on your package manager of choice, run `npm --version` or `yarn --version`. If you don't have it installed, please visit:
 
@@ -143,6 +143,11 @@ We are continuously working on improving the CLI. But, as of this current stable
 - We are open to pull requests for the CLI!
 - Before making a pull request, be sure to read the [contribution guidelines](https://github.com/devisle/advanced-react-cli/blob/master/CONTRIBUTING.md) that also have the pull request guide.
 
+5. How can I run the documentation site?
+
+- The documentation site is built using [docsify](https://docsify.js.org/#/).
+- Run the site `docsify serve docs`.
+
 ## Dev Isle Community
 
 Are you interested in hanging out, contributing to our open-source repos and be a part of a good community? We would love for you to join us on our [Discord](http://discord.gg/MSTQKRE).

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,110 @@
+## About
+
+This is an npm package which aims to provide a better way to install a React starter application and third-party packages for your application through an intuitive CLI.
+
+### Project's Purpose
+
+We at Dev Isle, felt that the community has been longing for a good, functional and intuitive CLI rather than always writing on the terminal command line.
+
+**Note**: We do not discourage or refrain the community from using terminal commands instructions. In fact, we highly recommend our users to read and understand the docs so that you will know what to expect. This CLI is merely an alternative!
+
+### What does this do?
+
+We are continuously working on improving the CLI. But, as of this current stable version, we have enabled a few options such as:
+
+- Yarn/NPM option for installation packages.
+- Installing React using `create-react-app`, with optional packages React-Router and Redux as a single bundle.
+- React Component generator lets you make a class/function component with optional package imports such as prop-types, react-router and redux!
+- Installing Individual packages such as Node-Sass, Styled-Components, React-Router, Prop-Types, and State Management.
+- Redux, Unstated, Unstated-Next and Redux-Thunk have been added in the State Management.
+- Installing Redux automatically generates a store folder containing boilerplate Redux code with instructions to get you started!
+- Installing Prop-Types automatically generates a file containing a sample code to get started!
+- Node-Sass and Styled-Components feature under StyledPackages section of the CLI.
+- Installing packages used for accesibility such as React-A11y and React-Axe.
+- TypeScript and `@types` definitions for Node, React, React-Router, React-Redux and Jest.
+
+#### Packages available for installation
+
+The CLI currently has these packages available for installation:
+
+- [Create-React-App](https://www.npmjs.com/package/create-react-app)
+- [React-Router](https://www.npmjs.com/package/react-router) & [React-Router-Dom](https://www.npmjs.com/package/react-router-dom)
+- [Redux](https://www.npmjs.com/package/redux) & [React-Redux](https://www.npmjs.com/package/react-redux)
+- [Redux-Thunk](https://www.npmjs.com/package/redux-thunk)
+- [Prop-Types](https://www.npmjs.com/package/prop-types)
+- [Node-Sass](https://www.npmjs.com/package/node-sass)
+- [Styled-Components](https://www.npmjs.com/package/styled-components)
+- [Unstated](https://www.npmjs.com/package/unstated)
+- [Unstated-Next](https://www.npmjs.com/package/unstated-next)
+- [TypeScript](https://www.npmjs.com/package/typescript)
+- [React-A11y](https://www.npmjs.com/package/react-a11y)
+- [React-Axe](https://www.npmjs.com/package/react-axe)
+- [@types/node](https://www.npmjs.com/package/@types/node)
+- [@types/react-redux](https://www.npmjs.com/package/@types/react-redux)
+- [@types/react](https://www.npmjs.com/package/@types/react) & [@types/react-dom](https://www.npmjs.com/package/@types/react-dom)
+- [@types/react-router](https://www.npmjs.com/package/@types/react-router) & [@types/react-router-dom](https://www.npmjs.com/package/@types/react-router-dom)
+- [@types/jest](https://www.npmjs.com/package/@types/jest)
+
+## Getting started
+
+### What do you need?
+
+Ensure you have git version control, and package manager - either npm (node package manager) or Yarn Installed. You may check if your system has them installed by running the following commands `git --version` and depending on your package manager of choice, run `npm --version` or `yarn --version`. If you don't have it installed, please visit:
+
+- [Git](https://git-scm.com/downloads) to download/install git.
+- [NodeJS](https://nodejs.org/en/download/) to download/install Node.Js (NPM gets installed with Node.Js).
+- [Yarn](https://yarnpkg.com/en/docs/getting-started) to download/install Yarn Package Manager
+
+### Run the CLI
+
+Run the following command:
+
+```sh
+npx advanced-react-cli
+```
+
+### Installing the CLI globally
+
+#### NPM
+
+```sh
+npm i -g advanced-react-cli
+```
+
+#### Yarn
+
+```sh
+yarn global add advanced-react-cli
+```
+
+## Credits
+
+### Used packages
+
+This CLI uses some of the best repos' terminal commands under the hood, to execute it's functionality. We would like to credit the following GitHub repos by making this CLI possible:
+
+- [Brandon Nozaki Miller - Node-CMD](https://github.com/RIAEvangelist/node-cmd)
+- [Simon Boudrias - Inquirer JS](https://github.com/SBoudrias/Inquirer.js/)
+- [Nathan Peck - CLUI](https://www.npmjs.com/package/clui)
+- [Dave Eddy - Clear](https://github.com/bahamas10/node-clear)
+- [Patorjk - Figlet](https://github.com/patorjk/figlet.js)
+- [Chalk](https://www.npmjs.com/package/chalk)
+
+**Be sure to check the above repos out if you're facing any issues! We are of course, always open to improvements.**
+
+### Authors
+
+- [@shreyas1307](https://github.com/shreyas1307) - Creator and Maintainer
+- [@endormi](https://github.com/endormi) - Maintainer
+- [@munsterberg](https://github.com/Munsterberg) - Contributor
+- [@natedeploys](https://github.com/Natedeploys) - Contributor
+- [@kruzus](https://github.com/kruzus) - Contributor
+- [@jgiamanco](https://github.com/jgiamanco) - Contributor
+
+## Dev Isle Community
+
+Are you interested in hanging out, contributing to our open-source repos and be a part of a good community? We would love for you to join us on our [Discord](http://discord.gg/MSTQKRE).
+
+## License
+
+The source code is released under the [GPL-3.0 License](https://github.com/devisle/advanced-react-cli/blob/master/LICENSE).
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,8 @@
+# Advanced-React-CLI
+
+> Better way to install packages for your react application through an intuitive CLI.
+
+[GitHub](https://github.com/devisle/advanced-react-cli)
+[About](#about)
+
+![color](#e7fcfd)
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>advanced-react-cli - docs</title>
+  <link rel="icon" href="images/favicon.ico" type="image/x-icon" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="NPM package which aims to provide a better way to install packages for your react application through an intuitive CLI">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app">Loading...</div>
+  <script>
+    window.$docsify = {
+      name: 'advanced-react-cli',
+      repo: 'https://github.com/devisle/advanced-react-cli',
+      themeColor: '#078eaf',
+      coverpage: true
+    }
+  </script>
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+</html>