@514labs/moose-cli 0.3.173 → 0.3.174

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -80
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,87 +1,21 @@
1
- # Moose CLI
1
+ <a href="https://www.moosejs.com/"><img src="logo-m-light.png" alt="moose logo" height="250px"></a>
2
2
 
3
- The Moose CLI is your entrypoint to a seamless, local development experience for your data-intensive application. It's written in rust and supports building applications in TypeScript and Python.
3
+ # MooseJS
4
4
 
5
- ## Installation
5
+ [![NPM Version](https://img.shields.io/npm/v/%40514labs%2Fmoose-cli?logo=npm)](https://www.npmjs.com/package/@514labs/moose-cli?activeTab=readme)
6
+ [![Moose Community](https://img.shields.io/badge/slack-moose_community-purple.svg?logo=slack)](https://join.slack.com/t/moose-community/shared_invite/zt-2fjh5n3wz-cnOmM9Xe9DYAgQrNu8xKxg)
7
+ [![Docs](https://img.shields.io/badge/quick_start-docs-blue.svg)](https://docs.moosejs.com/)
8
+ [![MIT license](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
6
9
 
7
- Before getting started you'll need to install some dependencies on your machine:
10
+ MooseJS is an open source developer framework for building data & analytics applications powered by a modern data stack. Moose takes the decades-old best practices of frontend and backend developer frameworks, and brings them to your data & analytics stack.
8
11
 
9
- 1. Node
10
- 2. Docker
12
+ # Getting started
13
+ To get started, check out the Moose documentation: [https://docs.moosejs.com/](https://docs.moosejs.com/)
11
14
 
12
- The Moose CLI is available as an NPM. To install the CLI, run the following command:
15
+ # Community
16
+ You can join the Moose community [on Slack](https://join.slack.com/t/moose-community/shared_invite/zt-2fjh5n3wz-cnOmM9Xe9DYAgQrNu8xKxg).
13
17
 
14
- ```bash
15
- npm install -g moose
16
- ```
18
+ Here you can get together with other Moose developers, ask questions, give feedback, make feature requests, and interact directly with Moose maintainers.
17
19
 
18
- ## Usage
19
-
20
- The Moose CLI is a command-line tool that allows you to create, manage, and deploy your Moose applications.
21
-
22
- ### Creating a new application
23
-
24
- To create a new application, run the following command:
25
-
26
- ```bash
27
- moose init
28
- ```
29
-
30
- This will prompt you to enter a name for your application. Once you have entered a name, the CLI will create a new directory with the name you provided and scaffold out a new Moose application.
31
-
32
- #### Application structure
33
-
34
- The CLI will create the following files and directories:
35
-
36
- ```
37
- ├── .moose
38
- │ ├── .clickhouse
39
- │ ├── .redpanda
40
- │ └── ...
41
- ├── .gitignore
42
- ├── README.md
43
- ├── package.json or requirements.txt
44
- ├── app
45
- │ ├── index.ts or index.py
46
- │ ├── dataframes
47
- │ │ └── ...
48
- │ ├── flows
49
- │ │ └── ...
50
- │ ├── ingests
51
- │ │ └── ...
52
- │ ├── insights
53
- │ │ ├── dashboards
54
- │ │ ├── metrics
55
- │ │ ├── models
56
- │ │ └── ...
57
- │ └── utils
58
- ```
59
-
60
- ##### `app` directory
61
-
62
- The `app` directory contains all of the code for your application. This includes all of the dataframes, flows, ingests, and insights that make up your application. This directory is where you will spend most of your time developing your application.
63
-
64
- ##### `.moose` for contributors only
65
-
66
- The `.moose` directory contains all of the configuration files for an application. This includes configuration for the local state of the application as well as any required local infrastructure. This directory is only used by contributors to the application and should not be committed to source control. Modifying files in this directory may cause unexpected behavior.
67
-
68
- ### Running your application in development mode
69
-
70
- To run your application, run the following command:
71
-
72
- ```bash
73
- moose dev
74
- ```
75
-
76
- This will start all of the required infrastructure and run your application in development mode. You can now make changes to your application and see them reflected in real-time.
77
-
78
- ### Seeing your application in action
79
-
80
- Once your application is running, you can see it in action by navigating to the following URLs:
81
-
82
- - [http://localhost:4000](http://localhost:4000) - Your application's interface if you've created one
83
- - [http://localhost:4000/console](http://localhost:4000/console) - A console to see the data flowing through your application and the objects you've created
84
-
85
- #### The console
86
-
87
- The console is a great way to see the data flowing through your application. It allows you to see the data flowing through your application in real-time and interact with the objects you've created. You can also use the console to run queries against your application's data.
20
+ # Made by 514
21
+ Our mission at [fiveonefour](https://www.fiveonefour.com/) is to bring incredible developer experiences to the data stack. If you’re interested in enterprise solutions, commercial support, or design partnerships, then we’d love to [chat with you](https://xbac8793a37.typeform.com/to/KTf5bBbr?typeform-source=www.fiveonefour.com).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@514labs/moose-cli",
3
- "version": "0.3.173",
3
+ "version": "0.3.174",
4
4
  "bin": {
5
5
  "moose": "dist/index.js",
6
6
  "moose-cli": "dist/index.js"
@@ -17,10 +17,10 @@
17
17
  "typescript": "^4.9.5"
18
18
  },
19
19
  "optionalDependencies": {
20
- "@514labs/moose-cli-darwin-arm64": "0.3.173",
21
- "@514labs/moose-cli-darwin-x64": "0.3.173",
22
- "@514labs/moose-cli-linux-arm64": "0.3.173",
23
- "@514labs/moose-cli-linux-x64": "0.3.173"
20
+ "@514labs/moose-cli-darwin-arm64": "0.3.174",
21
+ "@514labs/moose-cli-darwin-x64": "0.3.174",
22
+ "@514labs/moose-cli-linux-arm64": "0.3.174",
23
+ "@514labs/moose-cli-linux-x64": "0.3.174"
24
24
  },
25
25
  "scripts": {
26
26
  "typecheck": "tsc --noEmit",