Skip to content

janm-dev/web

Repository files navigation

Website

The janm.dev website.

Related projects

  • qna - Cross-screen QnA question queue.
  • ws-relay - Websocket relay server.

Running locally

  1. Make sure Node.js (v14.17.0 or later), npm, and yarn are installed. Clone this repository.
  2. In the root directory of this project, run yarn install to install all dependencies.
  3. Optionally, add a file named .env with the contents NEXT_PUBLIC_NAME=local.janm.dev.
  4. Run yarn start to start a development webserver. This will automatically refresh the site when you change any file. This is recommended for development.
  5. Optionally, run yarn build and npx serve -s build to create and view an optimized production version. This is recommended for final tests before committing.

Design

The design files for this project are available (read-only) on figma. There, you can find the library of colors and fonts that the project uses, the website design files, as well as various other assets (for example the logo).

Not all pages, assets, and components are fully represented in the design files.

Attribution

License

The privacy policy (privacy-policy.md) is licensed under the Creative Commons Sharealike (CC BY-SA 4.0) license.

The design for this project is licensed under the Creative Commons Sharealike (CC BY-SA 4.0) license.

The rest of this project is licensed under GNU AGPLv3 or later (AGPL-3.0-or-later). You can find the full license text in the LICENSE file.