Website • Discord • Releases • Donate • Documentation

Documentation

• Documentation for the dahliaOS project.
• Read the documentation on the link here!

Development

To develop and locally test the documentation website:

Step 1. Install development tools:

1. Install Node.js and NPM
2. Install PNPM (recommended opposed to NPM/Yarn)
3. Code editor of your choice (we recommend VSCode)

Step 2. Install dependencies:

Install node modules required to run the website by running:

pnpm i

Step 3. Start the Next.js dev server:

pnpm dev

In a browser, load the page localhost:3000 and you should now be able to test the website while making your changes. Next.js' dev server has hot reloading so no need to restart the instance when it's running!

Step 4. Build:

After making your changes and verifying it all works in the dev server, furtherly test them out by building the website:

pnpm build

Step 5. Start:

pnpm start

In a browser, load the page localhost:3000 and you should now be able to view the built website.

Contribute

If you're wondering how to contribute to the project, please refer to CONTRIBUTING.md

Sponsored by

License

Copyright @ 2019-2022 - The dahliaOS Authors - [email protected]

This project is licensed under the Apache 2.0 license