feat: initial commit and template import
This commit is contained in:
73
README.md
Normal file
73
README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
## viterjs-template
|
||||
|
||||
JavaScript + React + Redux + Mui + Axios + ESLint + Prettier
|
||||
|
||||

|
||||
|
||||
### Getting Started
|
||||
|
||||
#### Clone the repo
|
||||
|
||||
```
|
||||
npx degit emre-cil/viterjs-template my-app
|
||||
```
|
||||
|
||||
```
|
||||
cd my-app
|
||||
```
|
||||
|
||||
#### Install Dependencies
|
||||
|
||||
```
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### Run
|
||||
|
||||
```
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
#### Paths
|
||||
|
||||
Application using absolute paths
|
||||
Example: '@/components/Counter/Counter';
|
||||
|
||||
if you don't want to use you can remove these lines from
|
||||
|
||||
> vite.config.js
|
||||
|
||||
```
|
||||
resolve: {
|
||||
alias: {
|
||||
'@': path.resolve(__dirname, 'src'),
|
||||
},
|
||||
extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
|
||||
},
|
||||
```
|
||||
|
||||
> jsconfig.json
|
||||
|
||||
```
|
||||
"paths": {
|
||||
"@/*": ["./*"]
|
||||
}
|
||||
```
|
||||
|
||||
### Scripts
|
||||
|
||||
| Script | Description |
|
||||
| ------------- | ---------------------------------- |
|
||||
| pnpm dev | Runs the application. |
|
||||
| pnpm build | Create builds for the application. |
|
||||
| pnpm preview | Runs the Vite preview |
|
||||
| pnpm lint | Display eslint errors |
|
||||
| pnpm lint:fix | Fix the eslint errors |
|
||||
| pnpm format | Runs prettier for all files |
|
||||
| pnpm test | Run tests |
|
||||
|
||||
### Check List
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user