Skip to content

Commit

Permalink
build: v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
benjifs committed Dec 13, 2022
0 parents commit b90ffd8
Show file tree
Hide file tree
Showing 89 changed files with 4,930 additions and 0 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VITE_OMDB_API_KEY="1234abcd"
21 changes: 21 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

{
"env": {
"browser": true,
"es2021": true,
"node": true
},
"parserOptions": {
"sourceType": "module"
},
"extends": "eslint:recommended",
"rules": {
"camelcase": ["error"],
"comma-dangle": 0,
"indent": [ 2, "tab" ],
"no-trailing-spaces": "error",
"semi": [2, "never"],
"quotes": ["error", "single"],
"guard-for-in": "error"
}
}
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.env
.netlify
build
dist
node_modules
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Benji Encalada Mora

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

# sparkles
<p align="center">
<img src="https://github.com/benjifs/sparkles/blob/main/public/assets/icons/favicon-144x144.png" alt="sparkles icon" />
</p>

[![Netlify Status](https://api.netlify.com/api/v1/badges/c0572dda-6712-4742-a980-3a40b0d42ec2/deploy-status)](https://app.netlify.com/sites/sprkls/deploys)

[sparkles](https://sparkles.sploot.com) is a [Micropub](https://micropub.spec.indieweb.org/) client. It supports [IndieAuth](https://indieauth.net/) for login and expects a [micropub endpoint](https://indieweb.org/Micropub/Servers) to communicate with to publish posts. It supports basic micropub content types and you can also add movies you have watched.

sparkles can also be installed as a [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) on supported devices which will add the app as a **share target** and also add some quick action options.

You can try it for yourself at: https://sparkles.sploot.com

## Development

### Requirements
* `node 18.12.1`
* `npm 9.2.0`
* `npm install -g netlify-cli`

### Environment Variables
| name | description | required |
| --- | --- | --- |
| VITE_OMDB_API_KEY | [OMDB API Key](https://www.omdbapi.com/) | optional |

### Build
* Clone this repository
* `npm install`
* Run `netlify dev` to test locally
* Frontend: `http://localhost:5173`
* Functions: `http://localhost:9000`
48 changes: 48 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>s p a r k l e s</title>

<!-- ICONS -->
<link rel="apple-touch-icon" sizes="57x57" href="/assets/icons/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/assets/icons/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/assets/icons/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/assets/icons/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/assets/icons/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/assets/icons/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/assets/icons/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/assets/icons/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/assets/icons/apple-icon-180x180.png">
<link rel="mask-icon" href="/assets/icons/safari-pinned-tab.svg" color="#E69BDD">
<link rel="icon" type="image/png" sizes="192x192" href="/assets/icons/android-icon-192x192.png">
<link rel="icon" type="image/png" sizes="16x16" href="/assets/icons/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="/assets/icons/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="64x64" href="/assets/icons/favicon-64x64.png">
<link rel="icon" type="image/png" sizes="96x96" href="/assets/icons/favicon-96x96.png">
<link rel="manifest" href="/manifest.json?v=20221024">
<meta name="msapplication-TileColor" content="#E69BDD">
<meta name="msapplication-TileImage" content="/assets/icons/ms-icon-144x144.png">
<meta name="msapplication-config" content="/browserconfig.xml">
<meta name="theme-color" content="#E69BDD">
<link rel="shortcut icon" href="/favicon.ico">

<!-- DEPENDENCIES -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css" integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A==" crossorigin="anonymous" referrerpolicy="no-referrer" />
</head>
<body>
<script>
if ('serviceWorker' in navigator) {
navigator.serviceWorker.register('/sw.js?v=20221023')
}
</script>
<div class="h-x-app h-app" hidden>
<a href="/" class="u-url">
<img src="/assets/icons/favicon-144x144.png" alt="sparkles" class="u-logo p-name">
</a>
</div>
<script type="module" src="/src/js/app.js?v=20221023"></script>
</body>
</html>
16 changes: 16 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[dev]
command = "npm run start:vite"
publish = "dist"
targetPort = 5173
port = 9000

[build]
command = "npm run build:vite"
publish = "dist"

[functions]
directory = "./src/functions"
node_bundler = "esbuild"

[template.environment]
VITE_OMDB_API_KEY = "OMDB API Key (optional)"
Loading

0 comments on commit b90ffd8

Please sign in to comment.