thibaud frere
update doc
20eea38
raw
history blame
1.95 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 Space: **[πŸ€— science-blog-template](https://huggingface.co/spaces/tfrere/science-blog-template)**<br/> and click `Duplicate this Space`.
2. Give it a **name**, choose **visibility**, and keep the **free CPU instance**.
3. **Clone** your new Space repository.
```bash
git clone git@hf.co:spaces/<your-username>/<your-space>
cd <your-space>
```
<br/>
4. Use **Node.js 20 or newer**. <br/>To manage versions, consider using **nvm**
- macOS/Linux: see [nvm-sh](https://github.com/nvm-sh/nvm)
- Windows: see [nvm-windows](https://github.com/coreybutler/nvm-windows)
```bash
nvm install 20
nvm use 20
node -v
```
5. Install lfs and pull files from the repository.
```bash
git lfs install
git lfs pull
```
<Note emoji="⚠️" variant="danger">If you attempt to push binary files without Git LFS installed, you will encounter an error.</Note>
6. Install dependencies.
<Sidenote>
```bash
cd app
npm install
```
<Fragment slot="aside">
Alternatively, you can use **Yarn** as your package manager.
</Fragment>
</Sidenote>
<br/>And that's it!
**You're ready to go!** πŸŽ‰
### Development
```bash
npm run dev
```
Once started, the dev server is available at `http://localhost:4321`.
### Build
```bash
npm run build
```
### Deploy
**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>
Serving the `dist/` directory on any static host is enough to deliver the site.
</Note>
<Note>
A [slugified-title].pdf and thumb.jpg are also generated at build time.<br/>You can find them in the public folder and point to them at `[domain]/public/thumb.jpg`.
</Note>