Skip to content

docs: Add instructions for building and developing locally - #85

Open
mdimado wants to merge 1 commit into
sern-handler:mainfrom
mdimado:patch-1
Open

docs: Add instructions for building and developing locally#85
mdimado wants to merge 1 commit into
sern-handler:mainfrom
mdimado:patch-1

Conversation

@mdimado

@mdimadomdimado commented Jan 24, 2025

Copy link
Copy Markdown

Fixes#81

@netlify

netlifyBot commented Jan 24, 2025

Copy link
Copy Markdown

Deploy Preview for sern-docs ready!

NameLink
🔨 Latest commit3cd7c41
🔍 Latest deploy loghttps://app.netlify.com/sites/sern-docs/deploys/679373a8d226790008816446
😎 Deploy Previewhttps://deploy-preview-85--sern-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@SrIzan10SrIzan10 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check these out. you could also move this to a CONTRIBUTING.md file.

Comment threadREADME.md
sern's clean, modern, and user-friendly web interface. (now built with [Starlight](https://starlight.astro.build/))


To build and develop the **sern-handler-website** locally, follow these steps:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"To build and develop the website locally, follow these steps"

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, I'll change

Comment threadREADME.md

### **Prerequisites**
1. **Install Bun**: Bun is used as the package manager and runtime for this project. Install it from the official website: [https://bun.sh/](https://bun.sh/).
2. **Node Version Manager (Optional)**: The `.nvmrc` file specifies the Node.js version. Use a version manager like `nvm` to ensure compatibility:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're using bun, not node

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was optional, but I'll remove it, mb

Comment threadREADME.md
To start a local development server:
```bash
bun dev
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

everything under this is unnecessary

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I'll remove the building and running locally part

Comment threadREADME.md
```

2. **Install Dependencies**:
Bun uses the `bun.lockb` file to manage dependencies. Run:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not true

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll simply remove it as well

Comment threadREADME.md
Comment threadREADME.md

---

### **Steps to Build and Develop**

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is too long i feel like

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should i change it to "steps"

@jacoobes

Copy link
Copy Markdown
Member

check these out. you could also move this to a CONTRIBUTING.md file.

Let's keep it in the README.md

@SrIzan10

Copy link
Copy Markdown
Member

hi there, will you fix the issues? if you want i can pick it up to merge this as soon as possible!

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

website: instructions on how to build and develop locally

3 participants

@mdimado@jacoobes@SrIzan10