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.
$ yarn install # or pnpm install or npm install
This boilerplate, uses for the generation of views, solid.js Solid Website
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
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!
install mock server dependencies
cd json-server && yarn
run server
cd json-server && yarn server
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
├── 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)
yarn husky:init
yarn prepare
restore .husky/pre-commit
chmod ug+x .husky/*
chmod ug+x .git/hooks/*