Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digichanges/solid-experience
https://github.com/digichanges/solid-experience
innovation-labx
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/digichanges/solid-experience
- Owner: DigiChanges
- License: mit
- Created: 2021-10-08T00:45:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T13:23:53.000Z (11 months ago)
- Last Synced: 2024-04-28T05:17:27.821Z (9 months ago)
- Topics: innovation-labx
- Language: TypeScript
- Homepage: https://solid-experience-one.vercel.app
- Size: 1.67 MB
- Stars: 15
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# solid-experience
## Usage
duplicate and rename .env.example to .env
Those templates dependencies are maintained via [yarn]
This is the reason you see a `yarn.lock`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
```bash
$ yarn install # or pnpm install or npm install
```
### This boilerplate, uses for the generation of views, solid.js [Solid Website](https://solidjs.com)
## Available Scripts
In the project directory, you can run:
### `yarn dev` or `yarn start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
### `yarn run build`
Builds the app for production to the `dist` folder.
It correctly bundles Solid Experience in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
## Mock server with json-server
install mock server dependencies
```bash
cd json-server && yarn
```
run server
```bash
cd json-server && yarn server
```
## Deployment
You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
Each feature is divided:
- Auth
- Role
- User
- Shared
The directory structures for business domains are as follows:
**Folder structure of a module**
```sh
├── assets
├── config
├── features
│ └── [your_domain/feature]
│ ├── constants
│ ├── helper
│ ├── hooks
│ ├── interfaces
│ ├── organisms
│ ├── repositories
│ ├── templates
│ ├── utils
│ └── validations
├── Pages
│ ├── domain
│ ├── error
│ └── spinner
├── App.tsx
└── services
```
---
As it is only a boilerplate, you have the freedom to structure the code whatever you want.
In this project you will find:
Basic authentication and authorization (http only cookies)
Language i18n (solid-i18n)
Sort and Filters
Http repositories (axios)
CRUD with form validations (solid-js-form, yup)
Permissions for dom elements (cash-dom)
Routing (solid-app-router)
## Husky
### Husky is available to run pre-commits, which check syntax with eslint and types with ts
```bash
yarn husky:init
```
```bash
yarn prepare
```
restore .husky/pre-commit
```bash
chmod ug+x .husky/*
chmod ug+x .git/hooks/*
```