Merge pull request #113 from SDOS2020/dev

Beta Release

Author: avisionx

.github/workflows/python-linter.yml

@@ -5,9 +5,9 @@ name: Python Linter
 
 on:
   push:
-    branches: [beta]
+    branches: [dev]
   pull_request:
-    branches: [beta, master]
+    branches: [dev, master]
 
 jobs:
   build:
@@ -24,8 +24,7 @@ jobs:
       - name: Install dependencies ✔️
         run: |
           python -m pip install --upgrade pip
-          pip install flake8 pytest
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          if [ -f requirements-test.txt ]; then pip install -r requirements-test.txt; fi
       - name: Lint with flake8 ✨
         run: |
           # stop the build if there are Python syntax errors or undefined names

.github/workflows/python-test.yml

@@ -0,0 +1,33 @@
+# This workflow will installs Python dependencies, and tests the codebase
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python Tests
+
+on:
+  push:
+    branches: [dev]
+  pull_request:
+    branches: [dev, master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        node-version: [12.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }} 🛎️
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies ✔️
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements-test.txt ]; then pip install -r requirements-test.txt; fi
+          python setup.py install
+      - name: Test with pytest ✨
+        run: |
+          pytest tests/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Reactonite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,12 +3,12 @@
    <h3 align="center">Reactonite</h3>
 
    <p align="center"><img src="https://github.com/SDOS2020/Team_3_Reactonite/workflows/Python%20Linter/badge.svg?branch=beta" />
-   <a onclick="window.open(this.href,'_blank');return false;" href="https://reactonite.github.io/reactonite/"><img src="https://img.shields.io/website?label=documentation&up_message=up&url=https%3A%2F%2Freactonite.github.io%2Freactonite%2F"/></p></a>
+   <a onclick="window.open(this.href,'_blank');return false;" href="https://reactonite.github.io/"><img src="https://img.shields.io/website?label=documentation&up_message=up&url=https%3A%2F%2Freactonite.github.io%2F"/></p></a>
 
    <p align="center">
       A transpiler to convert HTML to React code and PWAs ✨
       </br>
-      <a href="https://reactonite.github.io/reactonite/"><strong>Explore the Docs »</strong></a>
+      <a href="https://reactonite.github.io/"><strong>Explore the Docs »</strong></a>
       <br/>
       <a href="https://github.com/SDOS2020/Team_3_Reactonite/#table-of-contents">Table of Contents</a> . <a href="https://github.com/SDOS2020/Team_3_Reactonite/issues">Report Bug</a> . <a href="https://github.com/SDOS2020/Team_3_Reactonite/projects">View Project</a>
    </p>
@@ -24,6 +24,7 @@
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
+  - [Development Setup](#development-setup)
 - [Usage](#usage)
 - [Roadmap](#roadmap)
 - [Contributing](#contributing)
@@ -43,7 +44,7 @@ Here's the key features added to Reactonite:
 - Act as a wrapper to NPM
 - Allow importing of already created HTML file components
 - Hot Reloading
-- Support custom scss, styled-components, material icons etc. :smile:
+- Support custom scss, js, css etc. :smile:
 
 ### Built With
 
@@ -59,13 +60,21 @@ To get this repo up and running on your local machine follow these simple steps.
 
 Here's a list of things you'll need to have prior to installing the software.
 
-- python
-- npm
-- nodejs
-- any modern web browser
+- Python
+- NPM
+- NodeJs
+- Any modern web browser
 
 ### Installation
 
+1. Use pip to install Reactonite
+
+```sh
+$ pip install reactonite
+```
+
+### Development Setup
+
 1. Setup virtual environment?
 
 ```sh
@@ -81,7 +90,7 @@ $ virtualenv venv
 $ git clone https://github.com/SDOS2020/Team_3_Reactonite.git
 ```
 
-2. Install the package either using pip or python setup tools
+3. Install the package either using pip or python setup tools
 
 ```sh
 $ python setup.py install
@@ -97,7 +106,7 @@ $ pip install .
 
 ## Usage
 
-Once installed refer to the [documentation](https://reactonite.github.io/reactonite/) for the set of commands available with Reactonite cli or you can begin by typing `reactonite --help` which opens the help page for `reactonite` command line tool.
+Once installed refer to the [documentation](https://reactonite.github.io/) for the set of commands available with Reactonite cli or you can begin by typing `reactonite --help` which opens the help page for `reactonite` command line tool.
 
 ```sh
 $ reactonite --help
@@ -128,7 +137,7 @@ Contributions are what make the open source community such an amazing place to b
 
 ## License
 
-License yet to be decided. See `LICENSE` for more information once complete.
+MIT License. See `LICENSE` for more information once complete.
 
 <!-- CONTACT -->
 

docs/source/_static/js/custom.js

@@ -0,0 +1,40 @@
+function is_valid(li) {
+  if (li.className.indexOf("toctree-l1") != -1) return true;
+  if (li.className.indexOf("toctree-l2") != -1) return true;
+  return false;
+}
+
+window.onload = function () {
+  var lis = document.getElementsByTagName("li"),
+    len = lis !== null ? lis.length : 0,
+    i = 0;
+  for (i; i < len; i++) {
+    if (is_valid(lis[i])) lis[i].className += " current";
+  }
+  fetch(
+    "https://raw.githubusercontent.com/reactonite/reactonite.github.io/master/versions.json"
+  )
+    .then((response) => response.json())
+    .then((json) => {
+      var sideNav = document.getElementsByClassName("wy-menu-vertical")[0];
+      var versionTitle = document.createElement("p");
+      versionTitle.className = "caption";
+      versionTitle.innerHTML =
+        "<span class='caption-text'>Docs Versions:</span>";
+      sideNav.appendChild(versionTitle);
+      var listUl = document.createElement("ul");
+      listUl.style =
+        "background: #c9c9c9; padding: 10px 0; font-weight: 400; font-size: 90%";
+      var listElements = "";
+      json.forEach((element) => {
+        listElements +=
+          '<li><a style="color: #404040; background: #c9c9c9;" href="/' +
+          element +
+          '/index.html">' +
+          element +
+          "</a></li>";
+      });
+      listUl.innerHTML = listElements;
+      sideNav.appendChild(listUl);
+    });
+};

docs/source/_static/js/expand_li.js

@@ -22,7 +22,7 @@
 copyright = '2020, Reactonite'
 author = 'Reactonite'
 
-version = '0.0.1-alpha'
+version = '0.1.0'
 
 # The full version, including alpha/beta/rc tags
 release = version
@@ -72,5 +72,5 @@
 html_favicon = './_static/favicon.ico'
 
 html_js_files = [
-    'js/expand_li.js',
+    'js/custom.js'
 ]

docs/source/conf.py

@@ -18,9 +18,8 @@ Here's the key features added to Reactonite:
 -  Transpile HTML code to React website
 -  Create PWAs and React applications as quickly as possible
 -  Act as a wrapper to NPM
--  Allow importing of already created HTML file components
 -  Hot Reloading
--  Support custom scss, styled-components, material icons etc.
+-  Support custom scss, js, css etc.
 
 
 Getting Started
@@ -43,34 +42,13 @@ software.
 Installation
 ------------
 
-1. Clone the reactonite repository to local machine.
+0. Install the package using pip
 
 .. code:: sh
 
-    $ git clone https://github.com/SDOS2020/Team_3_Reactonite.git
+    $ pip install reactonite
 
-1. Setup virtual environment?
-
-.. code:: sh
-
-    $ cd Team_3_Reactonite
-    $ python -m venv env
-    $ env\Scripts\activate    # For Windows
-    $ source env/bin/activate # For Linux
-
-> Not necessary but recommended to keep your environment clean.
-
-3. Install the package either using pip or python setup tools
-
-.. code:: sh
-
-    $ python setup.py install
-    # Use `develop` instead of `install` to get an editable build
-
-    # Alternatively run
-    $ pip install .
-
-4. You are good to go... 🎉
+1. You are good to go, yes it's that simple... 🎉
 
 
 Usage
@@ -86,19 +64,23 @@ Opens the help page for ``reactonite`` commandline.
 
 .. code:: sh
 
-    $ reactonite
+    $ reactonite --help
     Usage: reactonite [OPTIONS] COMMAND [ARGS]...
 
     Entry point for Reactonite cli.
 
     Options:
-    --help  Show this message and exit.
+    --version  Show the version and exit.
+    --help     Show this message and exit.
 
     Commands:
+    build              Command to get a static build of your app after...
     create-project     Command for creating new Reactonite project from...
+    gui                Command to start realtime development transpiler and...
     start              Command to start realtime development transpiler for...
     transpile-project  Command for transpiling a Reactonite project built...
 
+
 ``reactonite create-project PROJECT_NAME``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -108,6 +90,16 @@ Creates a Reactonite project with required directory structure. Change ``PROJECT
 
     $ reactonite create-project my-new-project
 
+    
+``reactonite gui PROJECT_NAME``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Creates a Reactonite project for GUI based development with required directory structure. Change ``PROJECT_NAME`` to your app name.
+
+.. code:: sh
+
+    $ reactonite gui my-new-project
+
 
 ``reactonite start``
 ~~~~~~~~~~~~~~~~~~~~
@@ -119,6 +111,16 @@ Starts watching for changes in Reactonite project ``src`` directory and builds t
     $ reactonite start
 
 
+``reactonite build``
+~~~~~~~~~~~~~~~~~~~~
+
+Generates a static build of your transpiled React app to be deployed to server. Requires config.json to be configured properly.
+
+.. code:: sh
+
+    $ reactonite build
+
+
 ``reactonite transpile-project``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/source/index.rst

@@ -4,6 +4,14 @@ reactonite package
 Submodules
 ----------
 
+reactonite.Config module
+------------------------
+
+.. automodule:: reactonite.Config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 reactonite.Constants module
 ---------------------------
 
@@ -12,6 +20,14 @@ reactonite.Constants module
    :undoc-members:
    :show-inheritance:
 
+reactonite.CreateHtmlCss module
+-------------------------------
+
+.. automodule:: reactonite.CreateHtmlCss
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 reactonite.Helpers module
 -------------------------