Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add instructions for building and developing locally #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add instructions for building and developing locally #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Copy link
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
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


### **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
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
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

```bash
nvm install
nvm use
```
3. **Git**: Make sure you have Git installed to clone the repository.

---

### **Steps to Build and Develop**
Copy link
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
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"

1. **Clone the Repository**:
```bash
git clone https://github.com/sern-handler/website.git
cd sern-handler-website
```

2. **Install Dependencies**:
Bun uses the `bun.lockb` file to manage dependencies. Run:
Copy link
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
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

```bash
bun install
```

3. **Development Server**:
To start a local development server:
```bash
bun dev
```
Copy link
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
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


4. **Build the Project**:
To generate a production-ready build:
```bash
bun build
```

5. **Run Locally**:
After building, you can preview the built site locally:
```bash
bun preview
```

Loading