Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
imkunet committed Nov 10, 2022
0 parents commit 9b2da58
Show file tree
Hide file tree
Showing 17 changed files with 2,913 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"env": {
"browser": true,
"es2021": true
},
"extends": [
"eslint:recommended",
"plugin:solid/typescript",
"plugin:@typescript-eslint/recommended",
"prettier"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": "latest",
"sourceType": "module"
},
"plugins": ["@typescript-eslint", "prettier", "solid"],
"rules": {
"prettier/prettier": ["warn"]
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
dist
5 changes: 5 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"singleQuote": true,
"trailingComma": "all",
"printWidth": 100
}
7 changes: 7 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"cSpell.words": [
"motionone",
"solidjs",
"tailwindcss"
]
}
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# solidjs-template

### **Please note: these are my personal settings and are not in any way endorsed or supported by SolidJS**

## What's inside

- [Motion One](https://motion.dev/)
- [ESlint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [TailwindCSS](https://tailwindcss.com/)
- [Typescript](https://www.typescriptlang.org/)
- [SolidJS](https://solidjs.com)

## Recommendations

This repo works best in vscode/forks with the ESLint, Prettier, and Typescript extensions installed and enabled!

## Getting started

You can get this template now in your terminal by running
```bash
npx degit imkunet/solidjs-template my-project
```
and then inside the project directory run
```bash
pnpm i
```

## Customization

Some things you might want to remember to change to your
own and or re-brand are:

- Project license
- `package.json` name and version
- `index.html` title, meta, and theme colors
- `src/assets/favicon.ico`

## Available Scripts

In the project directory, you can run:

### `pnpm dev` or `pnpm start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br>

### `pnpm run build`

Builds the app for production to the `dist` folder.<br>
It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!

## Deployment

You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
18 changes: 18 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta property="og:title" content="SolidJS Template" />
<meta property="og:description" content="Description for your SolidJS app!" />
<link rel="shortcut icon" type="image/ico" href="/src/assets/favicon.ico" />
<title>SolidJS Template</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>

<script src="/src/index.tsx" type="module"></script>
</body>
</html>
31 changes: 31 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "solidjs-template",
"version": "0.0.1",
"description": "Lorem ipsum dolor sit amet",
"scripts": {
"dev": "vite",
"build": "vite build",
"serve": "vite preview"
},
"license": "MIT",
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.42.1",
"@typescript-eslint/parser": "^5.42.1",
"autoprefixer": "^10.4.13",
"eslint": "^8.27.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-solid": "^0.8.0",
"postcss": "^8.4.18",
"prettier": "^2.7.1",
"tailwindcss": "^3.2.3",
"typescript": "^4.8.4",
"vite": "^3.2.3",
"vite-plugin-solid": "^2.4.0"
},
"dependencies": {
"@motionone/solid": "^10.14.3",
"motion": "^10.14.3",
"solid-js": "^1.6.1"
}
}
Loading

0 comments on commit 9b2da58

Please sign in to comment.