Set up the Galaxy frontend's stack (#433)

* Setup webpacker for typescript

* Typescript is working

* Add documentation to set up the Galaxy project and start contributing to it

* Add Storybook

* Add Jest

* Remove tuistenv from the .gitignore

* Run rubocop

.circleci/config.yml

@@ -144,6 +144,11 @@ jobs:
             bundle exec rails db:schema:load
             bundle exec rake test
 
+      - run:
+          name: Javascript tests
+          command: |
+            yarn test
+
   galaxy-deploy:
     docker:
       - image: buildpack-deps:trusty

.gitignore

@@ -98,7 +98,6 @@ Carthage/Checkouts
 *.profraw
 tuist.zip
 build/
-tuistenv
 TODO
 TODO.md
 mkmf.log

.vscode/settings.json

@@ -15,7 +15,7 @@
   },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "files.exclude": {
-    "**/.git*": true,
+    "**/.git": true,
     "**/node_modules": true,
     "**/.DS_Store": true
   }

Sources/tuistenv/main.swift

@@ -0,0 +1,5 @@
+import Foundation
+import TuistEnvKit
+
+var registry = CommandRegistry()
+registry.run()

docs/.gitignore

@@ -1,2 +1,3 @@
 node_modules
-.docz
+.docz
+yarn-error.log

docs/contribution/2-galaxy.md

@@ -0,0 +1,43 @@
+---
+name: Galaxy
+menu: Contributors
+---
+
+# Galaxy
+
+Galaxy is a [Rails](https://rubyonrails.org/) application that exposes a [GraphQL API](https://graphql.org/learn/) that is consumed by a [React](https://reactjs.org/) frontend that is bundled and served by Rails using [Webpacker](https://github.com/rails/webpacker).
+
+## Set up for development
+
+- Git clone the repository: `git clone git@github.com:tuist/tuist.git`.
+- Install [Postgress](https://www.postgresql.org/download/macosx/).
+- Choose the galaxy directory: `cd galaxy`.
+- Install Bundler dependencies: `bundle install`.
+- Install NPM dependencies: `yarn install`.
+- Run: `rails start`.
+
+## Running tests
+
+- Rails unit tests: `rails test`.
+- Frontend tests: `yarn test`.
+
+## Storybook
+
+The project has [Storybook](https://storybook.js.org/) configured, a Javascript tool to create a catalogue for the project components. The catalogue entries are called stories, and they are defined in the directory `stories/`.
+
+To run the catalogue, just run the command `yarn storybook` in your terminal. That'll transpile the catalogue and open the browser with it.
+
+## Useful commands
+
+- `rails db:drop`: Deletes the database.
+- `rails db:create`: Creates the database.
+- `rails db:migrate`: Migrates the database structure.
+
+## Useful resources
+
+- [Rails](https://rubyonrails.org/)
+- [Styled components](https://www.styled-components.com/)
+- [Relay](https://relay.dev/)
+- [GraphQL](https://graphql.org/learn/)
+- [React](https://reactjs.org/)
+- [Webpacker](https://github.com/rails/webpacker)

docs/doczrc.js

@@ -1,4 +1,4 @@
-import doczPluginNetlify from "docz-plugin-netlify";
+import doczPluginNetlify from 'docz-plugin-netlify'
 
 export default {
   title: 'Tuist Documentation',
@@ -27,15 +27,15 @@ export default {
       width: 100,
     },
     styles: {
-      "body": `
+      body: `
         font-family: -apple-system, system-ui, "Helvetica Neue", Helvetica, Arial, Verdana, sans-serif;
       `,
       code: `
         font-size: 13px;
         font-family: Menlo, Consolas, Monaco, "Courier New", monospace, serif;
         background-color: white;
-      `
-    }
+      `,
+    },
   },
   public: './public',
   htmlContext: {
@@ -66,6 +66,7 @@ export default {
       name: 'Contributors',
       menu: [
         'Getting started',
+        'Galaxy',
         'Code of conduct',
         'Changelog guidelines',
         'Core team',

docs/package.json

@@ -1,7 +1,5 @@
 {
-  "devDependencies": {
-    "react-hot-loader": "^4.9.0"
-  },
+  "devDependencies": {},
   "scripts": {
     "docz:dev": "docz dev",
     "docz:build": "docz build"