diff --git a/packages/app/README.md b/packages/app/README.md index a84af39..215a165 100644 --- a/packages/app/README.md +++ b/packages/app/README.md @@ -1,32 +1,20 @@ -# SolidStart +# @pipelineui/app Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com); -## Creating a project +## Structure -```bash -# create a new project in the current directory -npm init solid@latest +- `src/locales/**`: Localization files and Lingui adapter +- `src/mocks`: mswjs mocks (currently disabled) +- `src/store`: App stores (such as editor, ui, user, etc.) +- `src/routes`: App routes +- `src/components`: App components + - `/About`: About pages components + - `/Editor`: Editor components + - `/Home`: Home components +- `src/lib`: Application specific functions, store extensions, api, session manager etc +- `src/ui`: Generic UI theme, components, etc. -# create a new project in my-app -npm init solid@latest my-app -``` +### GitHub API -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```bash -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` - -## Building - -Solid apps are built with _presets_, which optimise your project for deployment to different environments. - -By default, `npm run build` will generate a Node app that you can run with `npm start`. To use a different preset, add it to the `devDependencies` in `package.json` and specify in your `app.config.js`. - -## This project was created with the [Solid CLI](https://solid-cli.netlify.app) +This project uses [ungh](https://github.com/unjs/ungh) from UnJS in order to call GitHub API.