https://github.com/dillonchanis/nx-remix

NX & Remix Project
https://github.com/dillonchanis/nx-remix

Last synced: about 2 months ago
JSON representation

NX & Remix Project

• Host: GitHub
• URL: https://github.com/dillonchanis/nx-remix
• Owner: dillonchanis
• Created: 2022-01-02T16:02:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-02T18:27:24.000Z (almost 3 years ago)
• Last Synced: 2023-03-04T15:14:04.412Z (almost 2 years ago)
• Language: TypeScript
• Size: 892 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NX + Remix

This is an example project that utilizes NX, Remix, Tailwind, and Storybook.

## Getting Started

Install the dependencies:

```bash

npm i

```

### Run the App

To run the Remix application named `demo`:

```bash

npx nx dev demo

```

### Run Storybook

A fake `ui` library was generated with this project that has a Button component. To view the Storybook page run:

```

npx nx storybook ui

```

## Adding new routes

```bash

npx nx g route

# e.g.

npx nx g route foo/bar --project=demo

```

## Workspace libraries

The Remix setup leverages npm/yarn/pnpm workspaces and Nx buildable libraries.

```bash

npx nx g @nrwl/remix:lib mylib

```

Import the new library in your app.

```javascript

// apps/demo/app/root.tsx

import { Mylib } from '@acme/mylib';

// ...

export default function App() {

  return (

    

      

        

        

      

    

  );

}

```

Now, run the dev server again to see the new library in action.

**Note:** You must restart the server if you make any changes to your library. Luckily, with Nx cache this operation should be super fast.

## Running unit tests

```

nx test remix

```

## Publishing

```

nx publish remix --ver=[version]

```

---

# Acme

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



🔎 **Smart, Fast and Extensible Build System**

## 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/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 shareable across libraries and applications. They can be imported from `@acme/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

### Distributed Computation Caching & Distributed Task Execution



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.