FineVision / app /src /content /chapters /getting-started.mdx
thibaud frere
update
c7b266f
raw
history blame
1.29 kB
import Sidenote from '../../components/Sidenote.astro';
## Getting Started
### Installation
<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
```
<small className="muted">- Serving the `dist/` directory on any static host is enough to deliver the site.</small>
<br/>
<small className="muted">- A [slug-title].pdf and thumb.jpg are also generated at build time. You can find them in the public folder.</small>
### Deploy
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 SDK as **Docker** (this project includes a `Dockerfile`).
3. Then push your changes to your new Space repo. **Every push automatically triggers a build and deploy** on Spaces.
```bash
git clone [email protected]:spaces/<your-username>/<your-space>.git
cd <your-space>
# Make edits locally, then:
git add .
git commit -m "Update content"
git push
```