Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ We welcome contributions including bug fixes, feature enhancements, documentatio

## Creating a Template

We do not maintain official templates and integration in this monorepo.
We do not maintain official templates and integrations in this monorepo.
Instead, please head over to [solidjs/templates](https://github.com/solidjs/templates) to submit your contribution.

## Documentation

We always want help and creative ways of explaining how to take the best out of SolidStart.
Alas, this is not the right place to do it, please head over to [SolidDocs](https://github.com/solidjs/solid-docs) and offer contribution to the official documentation!
Alas, this is not the right place to do it, please head over to [SolidDocs](https://github.com/solidjs/solid-docs) and contribute to the official documentation!

## Feature Request

> [!IMPORTANT]
> Do not create a PR without first discussion in an issue
> Do not create a PR without prior discussion in an issue

If there's a new feature you'd like to request you can:

1. Create an issue and make your pitch. Be sure to explain the value proposition in a way that will benefit most users.

2. If it's a more general concept, feel free to open a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **Idea** category.

A new **primitive** follows the same criteria as issues, please create an issue for it to be discussed before hand.
A new **primitive** follows the same criteria as issues, please create an issue for it to be discussed beforehand.

Primitives that depend on multiple external dependencies and 3rd party integrations are generally not a good fit to live inside this monorepo, we still welcome you to create it and share with the ecosystem.
Reach out in a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **showcase** session and we'll amplify as much as we can!
Reach out in a [Discussion](https://github.com/solidjs/solid-start/discussions) in the **showcase** section and we'll amplify as much as we can!

## Found a Bug

Expand All @@ -42,21 +42,21 @@ Create a **minimal** reproduction either in a remote IDE or in an open-source re

We recommend using the `create-solid` package with the **basic** setting.

| Package Manager | Command |
| --------------- | ------------------------------------------ |
| pnpm | `pnpm create solid -s -t basic` |
| npm | `npm create solid -s -t basic` |
| yarn | `yarn create solid -s -t basic` |
| bun | `bun create solid -s -t basic` |
| deno | `deno run -A npm:create-solid -s -t basic` |
| Package Manager | Command |
| --------------- | ---------------------------------------- |
| pnpm | `pnpm create solid@latest -st basic` |
| npm | `npm create solid@latest -- -st basic` |
| yarn | `yarn create solid -st basic` |
| bun | `bun create solid@latest --s --t basic` |
| deno | `deno run -A npm:create-solid -st basic` |

### Failing Test PR

You can also fork this repository and go to `apps/tests`.
There we have an app with all default configurations and many routes.
Create a new route, a Cypress assertion to it and open a PR with the failing test-case.

Once the PR is there, **create an issue** and link the PR (mention the PR as you'd mention a person in the issue description and vice-versa).
Once the PR is there, **create an issue** and link the PR (mention the PR as you'd mention a person in the issue description and vice versa).

> [!IMPORTANT]
> Mark the **allow edit by the maintainers** so we can more easily investigate the failing test and propose a fix. Otherwise we may need to close your PR and cherry-pick your commit.
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Banner](https://assets.solidjs.com/banner?project=Start&type=core)](https://github.com/solidjs)

<div align="center">

[![Banner](https://assets.solidjs.com/banner?project=Start&type=core)](https://github.com/solidjs)

[![Version](https://img.shields.io/npm/v/@solidjs/start.svg?style=for-the-badge&color=blue&logo=npm)](https://npmjs.com/package/@solidjs/start)
[![Downloads](https://img.shields.io/npm/dm/@solidjs/start.svg?style=for-the-badge&color=green&logo=npm)](https://npmjs.com/package/@solidjs/start)
[![Stars](https://img.shields.io/github/stars/solidjs/solid-start?style=for-the-badge&color=yellow&logo=github)](https://github.com/solidjs/solid-start)
Expand All @@ -10,19 +10,19 @@

</div>

- For building apps with SolidStart, check the [package README](/packages/start/README.md) and our [official docs](https://docs.solidjs.com/solid-start)
- For contributing to codebase, check [CONTRIBUTING.md](/CONTRIBUTING.md)
- For creating a new template, please head on to [solidjs/templates](https://github.com/solidjs/templates)
- For instructions on building with SolidStart, check the [package README.md](/packages/start/README.md) and our [official docs](https://docs.solidjs.com/solid-start)
- For creating a new template, please head over to [solidjs/templates](https://github.com/solidjs/templates)

## Prerequisites

- **Node.js**: Use the version specified in `.nvmrc`, to manage multiple versions across your system, we recommend a version manager such as [fnm](https://github.com/Schniz/fnm), or another of your preference.
- **Node.js**: Use the version specified in `.nvmrc`. To manage multiple versions across your system, we recommend a version manager such as [fnm](https://github.com/Schniz/fnm), or another of your choice.
- **pnpm**: Install globally via `npm install -g pnpm`. Or let **Corepack** handle it in the setup step below.
- **Git**: Ensure Git is installed for cloning and managing the repository
- **Git**: Ensure Git is installed for cloning and managing the repository.

## Monorepo Structure

SolidStart is a pnpm-based monorepo with nested workspaces. Key directories include
SolidStart is a pnpm-based monorepo with nested workspaces. Key directories include:

- **`packages/start`**: The core `@solidjs/start` package.
- **`apps/landing-page`**: The official landing page.
Expand Down Expand Up @@ -52,7 +52,7 @@ Use pnpm filters (e.g. `pnpm --filter @solidjs/start ...`) to target specific pa
pnpm dedupe
```

(`pnpm dedupe` will install dependencies _and_ clean the lockfile from duplicates, useful to preventing conflicts).
(`pnpm dedupe` will install dependencies _and_ clean the lockfile from duplicates, useful for preventing conflicts).

4. Build all packages and the landing page
```bash
Expand All @@ -69,7 +69,7 @@ Then reinstall dependencies and rebuild.

## Running Tests

End-to-end tests are located in `apps/tests` projects. For manual testing and development there's the `apps/fixtures` apps, and finally, integration and unit tests live inside their respective packages.
End-to-end tests are located in `apps/tests` projects. For manual testing and development use the `apps/fixtures` apps, and finally, integration and unit tests live inside their respective packages.

1. Install the Cypress binary (required only once)

Expand Down
4 changes: 2 additions & 2 deletions packages/start/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export default defineConfig({
});
```

Presets also include runtimes like Node.js, Bun or Deno. For example, a preset like `node-server` enables hosting on your server.
Presets also include runtimes like Node.js, Bun, or Deno. For example, a preset like `node-server` enables hosting on your server.
Learn more about [`defineConfig`](https://docs.solidjs.com/solid-start/reference/config/define-config)

## Building
Expand All @@ -89,4 +89,4 @@ After the build completes, you’ll be guided through deployment for your specif
## Contributing

- For contributing to the codebase, check [CONTRIBUTING.md](https://github.com/solidjs/solid-start/blob/main/CONTRIBUTING.md)
- For creating a new template, please head on to [solidjs/templates](https://github.com/solidjs/templates)
- For creating a new template, please head over to [solidjs/templates](https://github.com/solidjs/templates)
Loading