docs: Add instructions for building and developing locally #85
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for sern-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
SrIzan10
requested changes
Jan 24, 2025
| @@ -1,3 +1,49 @@ | |||
| # Website (v2) | |||
|
|
|||
| 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: | |||
There was a problem hiding this comment.
"To build and develop the website locally, follow these steps"
|
|
||
| ### **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: |
There was a problem hiding this comment.
It was optional, but I'll remove it, mb
| To start a local development server: | ||
| ```bash | ||
| bun dev | ||
| ``` |
There was a problem hiding this comment.
everything under this is unnecessary
There was a problem hiding this comment.
OK, I'll remove the building and running locally part
| ``` | ||
|
|
||
| 2. **Install Dependencies**: | ||
| Bun uses the `bun.lockb` file to manage dependencies. Run: |
|
|
||
| --- | ||
|
|
||
| ### **Steps to Build and Develop** |
Let's keep it in the README.md |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #81