npm package: @galaxy/core
Description: ## Getting started
Latest version: 0.0.12
Deprecated: this packages has been deprecated

# Galaxy

## Getting started

```bash
$ git clone git@github.com:digitalcube/galaxy.git
$ yarn (or npm install)
```

### Start a demo application

We can run the demo application for the libraries.

```bash
$ yarn start
```

The application code are in `apps/demo`.

### Start a Storybook

We can run storybook application by the command.

```bash
$ yarn storybook
```

The command will build the entire library's story.

## Project directories

### Root

```bash% tree -L 1
.
├── README.md
├── dist             : Builded artifacts (Git ignored / Should publish it to npm or any other registory)
├── apps             : Demo application directory
├── libs             : Packages directory
├── storybook-static : Builded Storybook artifacts (Git ignored / Should deploy to Netlify or AWS Amplify console)
=== Dev tools or configs ===
├── babel.config.json : Buld config
├── jest.config.js    : Test config
├── jest.preset.js    : Test config
├── nx.json           : Nx CLI config
├── tools             : Nx tools
├── workspace.json    : Nx workspace config
├── tsconfig.base.json: TypeScript config
├── node_modules      : node modules
├── package.json      : package config
└── yarn.lock         : Lock file of yarn

6 directories, 10 files

```

### Packages

```bash
libs
├── core        : [@galaxy/core] General Components and Utility Functions
├── views       : [@galaxy/views] General View templates
├── amimoto     : [@galaxy/amimoto] Components / Templates for AMIMOTO (Web and Dashboard)
├── amimoto-web : [@galaxy/amimoto-web] Templates for AMIMOTO website
├── shifter     : [@galaxy/shifter] Components / Templates for Shifter (Web and Dashboard)
└── shifter-web : [@galaxy/shifter-web] Templates for Shifter website

6 directories, 0 files
```

## Development

### Add a new React Component files

```bash
$ yarn nx g @nrwl/react:component NEW_COMPONENT_NAME --project=PROJECT_NAME --export

# Eg.) New core component named Tooltip
$ yarn nx g @nrwl/react:component Tooltip --project=core --export

# Eg.) New view component for shifter-web named Footer
$ yarn nx g @nrwl/react:component Footer --project=shifter-web --export
```

And we can add a story file for the Storybook by the command.

```bash
% yarn nx g component-story --project=PROJECT_NAME --componentPath=lib/{NEW_COMPONENT_NAME}.tsx
```

### Run unit test and lint

```bash
# ESlint
$ yarn libs:lint

# Prettier
$ yarn libs:format

# Jest
$ yarn libs:test
```

### Build projects

```bash
# Build the entire packages
$ yarn lib:build

# Build a Storybook
$ yarn storybook:build

# Build a demo application
$ yarn build
```

### Add a new library for publishing

We can setup a new library by using Nx CLI.

```bash
$ yarn nx g @nrwl/react:library LIBRARY_NAME --publishable --importPath=@galaxy/LIBRARY_NAME
```

And you need to update the `package.json` file like this.

```json
-    "libs": "nx run-many --projects \"core,shifter-web\"",
+    "libs": "nx run-many --projects \"core,shifter-web,LIBRARY_NAME\"",
```

### Release the packages

```bash
$ ./scripts/publish-libraries.sh
```

#### Publish to GitHub package registory

If you want to publish it to GitHub package registory, you should add a `.npmrc`

```
//npm.pkg.github.com/:_authToken=GITHUB_ACCESS_TOKEN
@digitalcube:registry=https://npm.pkg.github.com
registry=https://registry.npmjs.org
always-auth=false
```

And we have to replace all library name from `@galaxy/NAME` to `@digitalcube/galaxy-NAME`.

## FAQ

### Where should we add a new component?

- General component -> @galaxy/core
- General templates / view -> @galaxy/views

- For AMIMOTO Dashboard -> @galaxy/amimoto
- For AMIMOTO Dashboard and Web -> @galaxy/amimoto
- For AMIMOTO Web -> @galaxy/amimoto-web

- For Shifter Dashboard -> @galaxy/shifter
- For Shifter Dashboard and Web -> @galaxy/shifter
- For Shifter Web -> @galaxy/shifter-web

## Appendix: Document about Nx

This project was generated using [Nx](https://nx.dev).

<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>

🔎 **Nx is a set of Extensible Dev Tools for Monorepos.**

## Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

- [React](https://reactjs.org)
  - `npm install --save-dev @nrwl/react`
- Web (no framework frontends)
  - `npm install --save-dev @nrwl/web`
- [Angular](https://angular.io)
  - `npm install --save-dev @nrwl/angular`
- [Nest](https://nestjs.com)
  - `npm install --save-dev @nrwl/nest`
- [Express](https://expressjs.com)
  - `npm install --save-dev @nrwl/express`
- [Node](https://nodejs.org)
  - `npm install --save-dev @nrwl/node`

There are also many [community plugins](https://nx.dev/nx-community) you could add.

## Generate an application

Run `nx g @nrwl/react:app my-app` to generate an application.

> You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

## Generate a library

Run `nx g @nrwl/react:lib my-lib` to generate a library.

> You can also use any of the plugins above to generate libraries as well.

Libraries are sharable across libraries and applications. They can be imported from `@galaxy/mylib`.

## Development server

Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

## Code scaffolding

Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component.

## Build

Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.

## Running unit tests

Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io).

Run `nx affected:test` to execute the unit tests affected by a change.

## Running end-to-end tests

Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).

Run `nx affected:e2e` to execute the end-to-end tests affected by a change.

## Understand your workspace

Run `nx dep-graph` to see a diagram of the dependencies of your projects.

## Further help

Visit the [Nx Documentation](https://nx.dev) to learn more.

## ☁ Nx Cloud

### Computation Memoization in the Cloud

<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p>

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit [Nx Cloud](https://nx.app/) to learn more.