Skip to content

Commit 238d5ff

Browse files
iliareshetoviliareshetov
committed
add initial release
0 parents  commit 238d5ff

23 files changed

+4003
-0
lines changed

‎.eslintrc.cjs‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
module.exports = {
2+
root: true,
3+
env: { browser: true, es2020: true },
4+
extends: [
5+
'eslint:recommended',
6+
'plugin:@typescript-eslint/recommended',
7+
'plugin:react-hooks/recommended',
8+
],
9+
ignorePatterns: ['dist', '.eslintrc.cjs'],
10+
parser: '@typescript-eslint/parser',
11+
plugins: ['react-refresh'],
12+
rules: {
13+
'react-refresh/only-export-components': [
14+
'warn',
15+
{ allowConstantExport: true },
16+
],
17+
},
18+
}

‎.gitignore‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?
25+
*.wasm

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Vite React TypeScript SQL.js Tailwind Boilerplate
2+
3+
This project is a boilerplate that utilizes Vite, React, TypeScript, Tailwind, and SQL.js (SQLite).
4+
5+
## Overview
6+
7+
This boilerplate serves as a starting point for building web applications that require a client-side, in-browser database powered by SQL.js.
8+
9+
- **Vite**: A fast, versatile build tool for web development that provides instant server start and optimized production builds.
10+
11+
- **React**: A popular JavaScript library for building user interfaces, enabling you to create interactive and responsive web applications.
12+
13+
- **TypeScript**: A statically typed superset of JavaScript that enhances code quality and developer productivity.
14+
15+
- **SQL.js**: A JavaScript library that uses emscripten to compile SQLite to webassembly
16+
17+
- **Tailwind CSS**: A utility-first CSS framework that makes styling your web application a breeze, allowing you to build beautiful and responsive user interfaces with ease.
18+
19+
### Live Demo
20+
21+
Here is a live demo that uses the SQLite database file of [Chinook database](https://database.guide/2-sample-databases-sqlite/) as an example. The Chinook is a sample database that provides a set of tables and data, making it a great starting point to experiment with SQL.js features and functionalities.
22+
23+
You can access the live demo at [Demo Link](https://iliareshetov.github.io/react-sqlite-boilerplate/).
24+
25+
## Getting Started
26+
27+
To get started with this boilerplate, follow these steps:
28+
29+
1. Clone this repository to your local machine.
30+
31+
```bash
32+
git clone https://github.com/iliareshetov/react-sqlite-boilerplate.git
33+
```
34+
35+
2. Install the project dependencies by running the following command in the project directory:
36+
37+
```bash
38+
npm install
39+
```
40+
41+
3. Start the development server with the following command
42+
43+
```bash
44+
npm run dev
45+
```
46+
47+
## Credits
48+
49+
This boilerplate is based on the work from the [sql-js/react-sqljs-demo](https://github.com/sql-js/react-sqljs-demo) repository. I want to express my gratitude for their contributions and providing the foundation for this project.

‎index.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<meta
8+
name="keywords"
9+
content="Vite, React, TypeScript, SQLite, Web Development"
10+
/>
11+
<meta name="description" content="Vite + React + TypeScript + SQLite" />
12+
<title>Vite + React + TS + SQLite</title>
13+
</head>
14+
<body>
15+
<div id="root"></div>
16+
<script type="module" src="/src/main.tsx"></script>
17+
</body>
18+
</html>

0 commit comments

Comments
 (0)