chore: add instructions

This commit is contained in:
Mauricio Siu 2024-06-30 19:32:48 -06:00
parent 4c428adec3
commit ba03290553

View File

@ -1,34 +1,26 @@
## Usage
# Solidjs Example
Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.
This repository contains an example of Solidjs application that is deployed on Dokploy.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
```bash
$ npm install # or pnpm install or yarn install
```
1. **Use Git Provider in Your Application**:
- Repository: `https://github.com/Dokploy/examples.git`
- Branch: `main`
- Build path: `/solidjs-simple`
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
2. **Add Environment Variables**:
- Navigate to the "Environments" tab and add the following variable:
```plaintext
NIXPACKS_START_CMD="pnpm run serve"
```
## Available Scripts
3. **Click on Deploy**:
- Deploy your application by clicking the deploy button.
In the project directory, you can run:
4. **Generate a Domain**:
- Click on generate domain button.
- A new domain will be generated for you.
- You can use this domain to access your application.
### `npm run dev` or `npm start`
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br>
### `npm run build`
Builds the app for production to the `dist` folder.<br>
It correctly bundles Solid in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
## Deployment
You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
If you need further assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc).