Ladies of Code Digitial Garden

• Ladies of Code Digitial Garden
  • About
  • Becoming a technical contributor to the Digital Garden
  • Adding a post to the Digital Garden
  • Setup
  • Run locally
  • See how the site looks in production
  • Tests
    • Test structure
  • Linting and formatting

About

This project is set up using nuxt 3. Find out more about the ambitions for this project here.

You can see the site here

Becoming a technical contributor to the Digital Garden

We would like to improve this site technically and we very much welcome open source contributors from the LoC community. Please see the existing set of improvements identified.

If you would be interested in contributing to these improvements, please express your interest on the issues themselves. We can then work together asynchronously on the issues.

In this project we work with feature branches & Pull Requests. If you have some changes you'd like us to review, please do open a Pull Request. This will then be reviewed by the Codeowners.

Adding a post to the Digital Garden

If you'd like to add a post to the Digital Garden, please follow the instructions in the CONTRIBUTORS file.

Setup

1. Ensure you have the minimum versions of npm and node as specified in the package.json engines section.
2. Make sure to install the dependencies:

# npm
npm install

Run locally

Start the development server on http://localhost:3000

npm run dev

See how the site looks in production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Checkout the deployment documentation for more information.

Tests

npm run test

Run all the tests in the suite.

npm run test:ui

and open this url in the browser http://localhost:51204/__vitest__/.

This provides a visual indication of the test run and may be helpful for debugging, more information here.

npx vitest name-of-test

To run a single test in isolate, you can target them using Vitest in this way

Test structure

All tests can be found in test directory. The folder structure follows the same structure of the src files.

More insight on decisions made in approach to tests can be found in Setting Up.

Linting and formatting

Checkout the scripts section of the package.json file to see the commands which can be run.

Typical developer flow after making local changes would be:

npm run format && lint