-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chris1/514 236 doc updates and testing of initial moose js flow (#280)
* update github link from nextra to moose * install and getting started updates * messaging and structure updates * minor changes to nic comments
- Loading branch information
Showing
8 changed files
with
96 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,6 @@ | |
"title": "Getting Started" | ||
}, | ||
"building": { | ||
"title": "Building a Data Service" | ||
"title": "Building Your App" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,41 @@ | ||
# Getting Started | ||
MooseJS is still in active development. We're working on stabilizing our APIs and adding more features. If you'd like to take it for a spin, we'd love to hear your feedback. | ||
# Introduction | ||
Welcome to the MooseJS documentation! MooseJS is still in early development, and we're talking to users and potential users all the time to make sure we're creating something valuable. If you're at all interested in what we're building here, then we'd love to talk to you! Please join our [Slack community](https://join.slack.com/t/igloocommunity/shared_invite/zt-25gsnx2x2-9ttVTt4L9LYFrRcM6jimcg) and reach out. We can't wait to hear from you! | ||
|
||
## Installation | ||
MooseJS is available on [npm](https://www.npmjs.com/package/moosejs). You can install it with the following command: | ||
--- | ||
|
||
```txt filename="Terminal" copy | ||
npx create-moose-app my-app | ||
``` | ||
## What is MooseJS? | ||
MooseJS is a JavaScript/Typescript framework for building data-intensive applications and services. Just like you use frontend application frameworks like NextJS to build your frontend applications, you can use MooseJS to build your data/analytics stack. MooseJS designed to be intuitive and scalable for software engineers who do not have a background in data engineering. You can combine MooseJS and your favorite frontend framework to build feature-rich, interactive data applications for your users and stakeholders. | ||
|
||
MooseJS is designed to be a batteries-included framework that helps you build your application without having to worry about the underlying data infrastructure. Under the hood, it's built with a Rust based core that helps you package, build and deploy your application to reliably take your apps from your local machine to production. | ||
|
||
## What types of applications can be built with MooseJS? | ||
MooseJS is great for any application that is based around a modern data/analytics stack. Any application where collecting data and extracting insights from that data is at the heart of the application. Common examples include: | ||
|
||
1. A data lake or data warehouse | ||
2. An LLM-powered application | ||
3. An AI/ML model platform | ||
4. A customer data analytics platform | ||
5. A monitoring / observability application | ||
|
||
## What's the key functionality? | ||
|
||
### Intuitive primatives | ||
The MooseJS framework offers three simple code-based primitives through which you can architect your entire application: | ||
- Data models, which define the structure of your data | ||
- Flows (coming soon), which move and transform your data | ||
- Insights (coming soon), which surface data to your users and downstream applications | ||
|
||
### Automated infrastructure | ||
Based on these primatives, MooseJS will automatically build and manage your underlying data infrastructure. The default infrastructure of a MooseJS application includes: | ||
- An ingestion API to capture data from other applications or services | ||
- A storage layer that queues up data on ingestion and stores it for later processing - based on open source (RedPanda) [https://redpanda.com/] and (Clickhouse) [https://clickhouse.com/] | ||
- An orchestration layer for managing data movement and transformations | ||
|
||
### Data engineering best practices built in | ||
MooseJS is a typed framework, so your entire infrastructure automatically has type checking built in on build + run. MooseJS also offers intuitive migration and change management workflows, for when your data structure inevitably grows and evolves. | ||
|
||
### Developer-first | ||
MooseJS is designed by software developers, for software developers. It's built from the ground up to enable software developement best practices, that are often hard to implement in the data engineering world. | ||
- Run your entire application locally in Dev mode, allowing you to develop and preview changes you make in real time | ||
- Utilize git-based version control and CI/CD friendly workflows | ||
- Built-in testing framework to ensure tests are run before deployment (coming soon) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"installation": "Installation", | ||
"project-structure": "Project Structure", | ||
"using-moose-cli": "Using the CLI" | ||
"moose-cli": "Moose CLI" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
apps/framework-docs/src/pages/getting-started/moose-cli.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Moose CLI | ||
|
||
MooseJS comes with a handy CLI for managing your MooseJS application. Navigate to your project's directory to run commands. There are two ways to run the CLI: | ||
|
||
Without installing Moose, you can run CLI commands via NPX: `npx @514labs/moose-cli [command]` | ||
|
||
If you've installed Moose, you can run CLI commands directly: `moose [command]` | ||
|
||
## Moose CLI commands | ||
|
||
### Init | ||
|
||
Instead of using `create-moose-app`, you can inialize your project manually with the CLI, if you'd like more flexibility and control. Either option will initialize a new MooseJS project for you, with all the necessary directories including temporary ones for data storage. | ||
|
||
```txt filename="Terminal" copy | ||
moose init <name> --language <language> --location <location> | ||
``` | ||
|
||
- `<name>`: Name of your app or service. | ||
- `--language <language>`: Language of your app or service. We currently only support `Typescript`. | ||
- `--location <location>`: Location of your app or service. Default is the current directory (`.`). | ||
|
||
### Dev | ||
|
||
Starts a development environment running the full stack of your MooseJS application locally. As you develop your MooseJS application locally, changes you make to your code base will be automatically reflected here in real time (when you save changes). | ||
|
||
```txt filename="Terminal" copy | ||
moose dev | ||
``` | ||
|
||
### Clean | ||
|
||
Clears all temporary data and stops development infrastructure. | ||
|
||
```txt filename="Terminal" copy | ||
moose clean | ||
``` |
31 changes: 0 additions & 31 deletions
31
apps/framework-docs/src/pages/getting-started/using-moose-cli.mdx
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters