Skip to content

Magenta-Mause/Cosy-Docs

Repository files navigation

cosy-landing-page

After cloning this repository

In order to get you started writing docs/enhancing our landing page, please make sure you follow these steps:

1. Bun Installation

We use bun as our bundler. For the installation, proceed as follows, depending on your operating system:

macOS / Linux

curl -fsSL https://bun.com/install | bash

Windows

powershell -c "irm bun.sh/install.ps1|iex"

npm

npm install -g bun

You may need to restart your terminal/command line after installation to make sure bun is availabel for use.

If you encounter any issues, feel free to consult the bun documentation or ask in the GC :)

2. Package Installation

We make use of various libraries to make our life easier (duh). Before starting development or behold - trying to start the project, please install all dependencies using the following command:

bun i

3. VS Code Setup

While you are technicall ready to start/build the frontend, you might want to make your development experience better by following these vs code integrations:

Starting / Building

To run the frontend with hot-reloading, please run:

bun run dev

If you want to create a final build, run:

bun run build

and then start your production build as follows:

bun run start