Merge pull request #85 from commitdev/implement-poc-ui

Issue #59: Implement poc ui

Author: Direside

.gitignore

@@ -2,4 +2,8 @@ main-packr.go
 packrd
 /commit0
 .history/
-tmp/
+tmp/
+
+# Generated files from Config UI.
+intenral/ui/node_modules
+intenral/ui/build

Makefile

@@ -52,10 +52,14 @@ build-example-docker: clean-example
 clean-example:
 	rm -rf example
 
+watch-ui:
+	cd internal/ui && yarn start
+
 # builds 
 build:
 	CGO_ENABLED=0 packr2 build -o commit0
 	packr2 clean
+	cd internal/ui && yarn && yarn build
 
 # Installs the CLI int your GOPATH
 install-go:

README.md

@@ -80,6 +80,25 @@ cd test-app
 ../../commit0 generate -c commit0.yml
 ```
 
+### Configuration UI
+
+If you're working on the configuration UI locally, you can run just the ui by doing the following.
+
+``` bash
+cd internal/ui
+yarn
+yarn start
+```
+
+If you want to test the full integration with the go app, you'll need to do a build and run the app with `./commit0 ui`.
+
+``` bash
+make build
+./commit0 ui
+```
+
+[http://localhost:8080/](http://localhost:8080/)
+
 ### Architecture
 The project is built with GoLang and requires Docker
 - /cmd - the CLI command entry points

internal/api/create_project.go

@@ -18,7 +18,7 @@ func createProject(projectConfig util.ProjectConfiguration) string {
 	t := templator.NewTemplator(templates)
 	outDir := "./"
 	rootDir := path.Join(outDir, projectConfig.ProjectName)
-	log.Printf("Creating project %s.", projectConfig.ProjectName)
+	log.Printf("Creating project %s.", projectConfig)
 	err := os.MkdirAll(rootDir, os.ModePerm)
 
 	if os.IsExist(err) {

internal/api/generate_api.go

@@ -2,10 +2,12 @@ package api
 
 import (
 	"encoding/json"
-	"github.com/gorilla/mux"
 	"log"
 	"net/http"
 
+	"github.com/gorilla/handlers"
+	"github.com/gorilla/mux"
+
 	"github.com/commitdev/commit0/internal/util"
 )
 
@@ -19,7 +21,7 @@ func generateProject(w http.ResponseWriter, req *http.Request) {
 		if err != nil {
 			panic(err)
 		}
-		log.Println(projectConfig.ProjectName)
+		log.Println(projectConfig)
 		createProject(projectConfig)
 		w.WriteHeader(http.StatusCreated)
 		w.Write([]byte(`{"message": "Post successful"}`))
@@ -28,13 +30,23 @@ func generateProject(w http.ResponseWriter, req *http.Request) {
 		w.WriteHeader(http.StatusNotFound)
 		w.Write([]byte(`{"message": "Not found"}`))
 	}
-
 }
 
 func Commit0Api() {
+	// React Frontend is served on port 3000 while in development mode.
+	allowOrigins := handlers.AllowedOrigins([]string{"http://localhost:3000"})
+	allowedMethods := handlers.AllowedMethods([]string{"POST", "OPTIONS"})
+	allowedHeaders := handlers.AllowedHeaders([]string{"content-type"})
+
 	var router = mux.NewRouter()
 	var api = router.PathPrefix("/v1/generate").Subrouter()
 	api.NotFoundHandler = http.HandlerFunc(generateProject)
 
-	log.Fatal(http.ListenAndServe(":8080", router))
+	staticHandler := http.StripPrefix("/static/", http.FileServer(http.Dir("internal/ui/build/static")))
+	router.PathPrefix("/static/").Handler(staticHandler)
+
+	buildHandler := http.FileServer(http.Dir("internal/ui/build"))
+	router.PathPrefix("/").Handler(buildHandler)
+
+	log.Fatal(http.ListenAndServe(":8080", handlers.CORS(allowOrigins, allowedMethods, allowedHeaders)(router)))
 }

internal/ui/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+build

internal/ui/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

internal/ui/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "commit0-ui",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@material-ui/core": "^4.6.1",
+    "@material-ui/icons": "^4.5.1",
+    "@material-ui/lab": "^4.0.0-alpha.32",
+    "axios": "^0.19.0",
+    "react": "^16.11.0",
+    "react-dom": "^16.11.0",
+    "react-scripts": "3.2.0"
+  },
+  "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"
+    ]
+  }
+}

internal/ui/public/favicon.ico

@@ -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="Commit0 Project Generator"
+    />
+    <link rel="apple-touch-icon" href="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>Commit0</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>