forked from buggyzap/reactjs-starter
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bfcef42
commit 53e9a75
Showing
2 changed files
with
42 additions
and
35 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 |
|---|---|---|
| @@ -1,20 +1,14 @@ | ||
| { | ||
| "name": "nodejs-starter", | ||
| "image": "ghcr.io/nuvolaris/devcontainer:3.1.0-mastrogpt.2403171925", | ||
| "mounts": [ | ||
| "source=/var/run/docker.sock,target=/var/run/docker-host.sock,type=bind" | ||
| ], | ||
| "remoteUser": "nuvolaris", | ||
| "overrideCommand": false, | ||
| "runArgs": [ | ||
| "--network=host" | ||
| ], | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": [ | ||
| "nuvolaris.nuvolaris-vscode-extension", | ||
| "ms-python.python" | ||
| ] | ||
| } | ||
| } | ||
| "name": "nuvolaris-starter", | ||
| "image": "ghcr.io/nuvolaris/devcontainer:3.1.0-mastrogpt.2404131430", | ||
| "runArgs": [ | ||
| "--init" | ||
| ], | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": [ | ||
| "nuvolaris.nuvolaris-vscode-extension" | ||
| ] | ||
| } | ||
| } | ||
| } |
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,28 +1,41 @@ | ||
| <p align="center"> | ||
| <img src="public/nuv-stacked-color.svg" width="128" height="128" /> | ||
| </p> | ||
| # Nuvolaris MastroGPT | ||
|
|
||
| Build easily AI applications with MastroGPT! | ||
|
|
||
| # React.js MastroGPT Starter ( Vite ) | ||
| # Setup | ||
|
|
||
| This is a starter template for React.js with MastroGPT bundled with Vite. It includes a sample AI application that uses MastroGPT. | ||
| You can run Nuvolaris Starter: | ||
| - Online with Codespace | ||
| - Locally with Docker | ||
|
|
||
| ## Deploy your own | ||
| ## Online Setup | ||
|
|
||
| ### Pre-requisites | ||
| - Get a GitHub account | ||
| - Fork this repo in your own account | ||
| - Start it with Codespaces (you have 60 free hours) | ||
| - See below for setup. | ||
|
|
||
| - Docker | ||
| ## Local Setup | ||
|
|
||
| ### Online with Github codespaces | ||
| - Install Docker and VScode in your machine | ||
| - Clone this repo | ||
| - Open it in VSCode | ||
| - Press F1 and the "Reopen in Container" | ||
|
|
||
| You can deploy your own React.js + MastroGPT project with a single click using Github codespaces. | ||
| # Environments and Secrets | ||
|
|
||
| [](https://codespaces.new/buggyzap/reactjs-starter) | ||
| - Copy the `.env.example` in `.env` | ||
| - Add your secrets there (do not commit them - it is in .gitignore) | ||
| - Add non secrets envirornment variables in packages/.env | ||
| - Pass secrets and environments to your function with `#--param ARGUMENT "$VARIABLE"` | ||
| - Read the secrets as function arguments | ||
|
|
||
| ### Locally with Docker | ||
| # Development | ||
|
|
||
| - Clone this repository | ||
| - Open Visual Studio Code and install Dev containers extensions if you haven't already | ||
| - Open the project in Visual Studio Code | ||
| - Click on the green button in the bottom left corner and select "Reopen in Container" | ||
| - On left menu click on "Nuvolaris" extension and select "Devel" | ||
| Use the Nuvolaris Icon to execute the functions, or use the following commands from the terminal: | ||
|
|
||
| - `devel` (or `nuv ide devel` to run a local development environment | ||
| - `deploy` (or `nuv ide deploy`) to deploy everything in cloud | ||
| - `login` (or `nuv ide login`) to login again | ||
|
|
||
| Check `nuv ide` subcommand for more options. |