Features/17 heroku support (#25)

Author: michael-yin

docs/index.md

@@ -28,6 +28,8 @@ frontend
 1. Static assets such as images, fonts and other files can be put at `vendors`
 
 ```bash
+$ cd frontend
+
 # install dependency packages
 $ npm install
 # build js, scss files

docs/run_npm_command_at_root.md

@@ -0,0 +1,19 @@
+# Run NPM command at root directory
+
+By default, the `package.json` will be placed at the `frontend` directory, which means, you need to run `npm` command under the `frontend` directory.
+
+If you do not like this and want to run `npm` command at the root directory.
+
+Please set `run_npm_command_at_root` to `y` when you create the `webpack` project.
+
+Below files will be placed at the root directory instead of the `frontend` directory.
+
+```
+.babelrc
+.browserslistrc
+.eslintrc
+.nvmrc
+.stylelintrc.json
+package-lock.json
+package.json
+```

mkdocs.yml

@@ -17,6 +17,7 @@ nav:
   - Setup With Django: setup_with_django.md
   - Setup With Flask: setup_with_flask.md
   - Frontend workflow: frontend.md
+  - Run NPM command at root directory: run_npm_command_at_root.md
   - Tailwind CSS: setup_with_tailwind.md
   - Import React: react.md
   - Import Vue: vue.md

pyproject.toml

@@ -24,7 +24,7 @@ python = "^3.6"
 cookiecutter = "^1.7.0"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["setuptools", "poetry_core>=1.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.black]

webpack_boilerplate/frontend_template/cookiecutter.json

@@ -1,3 +1,4 @@
 {
-    "project_slug": "frontend"
+  "project_slug": "frontend",
+  "run_npm_command_at_root": "n"
 }

webpack_boilerplate/frontend_template/hooks/post_gen_project.py

@@ -0,0 +1,69 @@
+import os
+import os.path
+import shutil
+
+TERMINATOR = "\x1b[0m"
+WARNING = "\x1b[1;33m [WARNING]: "
+INFO = "\x1b[1;33m [INFO]: "
+HINT = "\x1b[3;33m"
+SUCCESS = "\x1b[1;32m [SUCCESS]: "
+
+DENY_LIST = [".gitignore"]
+ALLOW_LIST = ["package.json", "package-lock.json"]
+
+
+def print_success_msg(msg):
+    print(SUCCESS + msg + TERMINATOR)
+
+
+def get_frontend_config_files():
+    frontend_path = os.getcwd()
+
+    for f in os.listdir(frontend_path):
+        if f.startswith(".") and f not in DENY_LIST:
+            full_path = os.path.join(frontend_path, f)
+            yield os.path.dirname(full_path), os.path.basename(full_path)
+
+    for f in ALLOW_LIST:
+        full_path = os.path.join(frontend_path, f)
+        yield os.path.dirname(full_path), os.path.basename(full_path)
+
+
+def copy_frontend_config_files():
+    for dirname, filename in get_frontend_config_files():
+        old_full_path = os.path.join(dirname, filename)
+        root_dir = os.path.dirname(dirname)
+        new_full_path = os.path.join(root_dir, filename)
+        shutil.copyfile(old_full_path, new_full_path)
+
+        os.remove(old_full_path)
+
+
+def update_webpack_path():
+    """
+    Update webpack config file path in package.json
+    """
+    file_path = "package.json"
+    with open(file_path, "r+") as f:
+        file_contents = f.read().replace(
+            "--config webpack/", "--config {{ cookiecutter.project_slug }}/webpack/"
+        )
+        f.seek(0)
+        f.write(file_contents)
+        f.truncate()
+
+
+def main():
+    if "{{ cookiecutter.run_npm_command_at_root }}".lower() == "y":
+        update_webpack_path()
+        copy_frontend_config_files()
+
+    print_success_msg(
+        f"Frontend app '{{ cookiecutter.project_slug }}' "
+        f"has been created. "
+        f"To know more, check https://python-webpack-boilerplate.rtfd.io/en/latest/frontend/"
+    )
+
+
+if __name__ == "__main__":
+    main()

webpack_boilerplate/frontend_template/{{cookiecutter.project_slug}}/package-lock.json

@@ -6,9 +6,9 @@ const WebpackAssetsManifest = require("webpack-assets-manifest");
 
 const getEntryObject = () => {
   const entries = {};
-  glob.sync("src/application/*.js").forEach((path) => {
+  glob.sync(Path.join(__dirname, "../src/application/*.js")).forEach((path) => {
     const name = Path.basename(path, ".js");
-    entries[name] = Path.resolve(__dirname, `../${path}`);
+    entries[name] = path;
   });
   return entries;
 };

webpack_boilerplate/frontend_template/{{cookiecutter.project_slug}}/webpack/webpack.common.js

@@ -8,14 +8,4 @@ def handle(self, *args, **options):
         from cookiecutter.main import cookiecutter
 
         pkg_path = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
-        app_path = cookiecutter(pkg_path, directory="frontend_template")
-
-        app_name = os.path.basename(app_path)
-
-        self.stdout.write(
-            self.style.SUCCESS(
-                f"Frontend app '{app_name}' "
-                f"has been successfully created. "
-                f"To know more, check https://python-webpack-boilerplate.rtfd.io/en/latest/frontend/"
-            )
-        )
+        cookiecutter(pkg_path, directory="frontend_template")