Skip to content

Commit 1e7c388

Browse files
ernstmulernstmul
authored
Merge pull request #1 from appwrite/feat-starter-kit
Feat starter kit
2 parents fdf03d3 + 83278db commit 1e7c388

File tree

15 files changed

+5438
-2
lines changed

15 files changed

+5438
-2
lines changed

‎.env.example‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
VITE_APPWRITE_ENDPOINT=
2+
VITE_APPWRITE_PROJECT_ID=
3+
VITE_APPWRITE_PROJECT_NAME=

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
26+
.env

‎README.md‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
# starter-for-react
2-
Appwrite's starter kit for React 👩‍💻
1+
# React Native starter kit with Appwrite
2+
3+
Kickstart your React development with this ready-to-use starter project integrated with [Appwrite](https://www.appwrite.io)
4+
5+
## 🚀Getting started
6+
7+
###
8+
Clone the Project
9+
Clone this repository to your local machine using Git:
10+
11+
`git clone https://github.com/appwrite/starter-for-react`
12+
13+
## 🛠️ Development guid
14+
1. **Configure Appwrite**<br/>
15+
Navigate to `.env` and update the values to match your Appwrite project credentials.
16+
2. **Customize as needed**<br/>
17+
Modify the starter kit to suit your app's requirements. Adjust UI, features, or backend
18+
integrations as per your needs.
19+
3. **Install dependencies**<br/>
20+
Run `npm install` to install all dependencies.
21+
4. **Run the app**<br/>
22+
Start the project by running `npm run dev`.
23+
24+
## 💡 Additional notes
25+
- This starter project is designed to streamline your React development with Appwrite.
26+
- Refer to the [Appwrite documentation](https://appwrite.io/docs) for detailed integration guidance.

‎eslint.config.js‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import js from '@eslint/js'
2+
import globals from 'globals'
3+
import react from 'eslint-plugin-react'
4+
import reactHooks from 'eslint-plugin-react-hooks'
5+
import reactRefresh from 'eslint-plugin-react-refresh'
6+
7+
export default [
8+
{ ignores: ['dist'] },
9+
{
10+
files: ['**/*.{js,jsx}'],
11+
languageOptions: {
12+
ecmaVersion: 2020,
13+
globals: globals.browser,
14+
parserOptions: {
15+
ecmaVersion: 'latest',
16+
ecmaFeatures: { jsx: true },
17+
sourceType: 'module',
18+
},
19+
},
20+
settings: { react: { version: '18.3' } },
21+
plugins: {
22+
react,
23+
'react-hooks': reactHooks,
24+
'react-refresh': reactRefresh,
25+
},
26+
rules: {
27+
...js.configs.recommended.rules,
28+
...react.configs.recommended.rules,
29+
...react.configs['jsx-runtime'].rules,
30+
...reactHooks.configs.recommended.rules,
31+
'react/jsx-no-target-blank': 'off',
32+
'react-refresh/only-export-components': [
33+
'warn',
34+
{ allowConstantExport: true },
35+
],
36+
},
37+
},
38+
]

‎index.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/appwrite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Appwrite + React</title>
8+
</head>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.jsx"></script>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)