robot-learning-tutorial / app /src /content /chapters /getting-started.mdx
thibaud frere
update
941cf22
raw
history blame
1.33 kB
import Sidenote from '../../components/Sidenote.astro';
import Note from '../../components/Note.astro';
## Getting Started
### Installation
The recommended way is to **duplicate this Space** on **Hugging Face** rather than cloning it directly:
1. Open the template Space: **[🤗 science-blog-template](https://huggingface.co/spaces/tfrere/science-blog-template)** and click **"Duplicate this Space"**.
2. Give it a name, choose visibility, and **keep the free CPU instance**.
3. Clone your new Space repo.
```bash
git clone git@hf.co:spaces/<your-username>/<your-space>
cd <your-space>
```
<Sidenote>
```bash
git lfs install
git lfs pull
cd app
npm install
```
<Fragment slot="aside">
Alternatively, you can use **Yarn** as your package manager.
</Fragment>
</Sidenote>
### Development
```bash
npm run dev
```
### Build
```bash
npm run build
```
### Deploy
Push your changes to your new Space repo.<br/>**Every push automatically triggers a build and deploy** on Spaces.
```bash
# Make edits locally, then:
git add .
git commit -m "Update content"
git push
```
<Note title="Note">
Serving the `dist/` directory on any static host is enough to deliver the site.
</Note>
<Note title="Note">
A [slug-title].pdf and thumb.jpg are also generated at build time.<br/>You can find them in the public folder.
</Note>