added readme

blackspike · Feb 1, 2021 · dce837b · dce837b
1 parent ed8edfc
commit dce837b
Show file tree

Hide file tree

Showing 88 changed files with 101 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,77 @@
-# colorpixel
+# pixel-artist
 
-Turns images into pixelated colour streams!
+A toy API to convert any bitmap image in to RBA colours!
 
-## Try these
+## Install & run
 
-https://upload.wikimedia.org/wikipedia/en/thumb/b/bc/Old_guitarist_chicago.jpg/1280px-Old_guitarist_chicago.jpg
+```
+npm install
+```
 
-https://artvee.com/saconud/sftb/204299DI01fg.jpg
+```
+node index.js
+```
+
+## Usage
+
+Reach the API at
+
+```
+https://pixel-artist.herokuapp.com/api/?cols=x&url=y
+```
+
+It accepts two parameters, columns: `cols` (min `4` max `64` default `32`); and `url` for any valid bitmap image
+
+Fewer columns, the faster! Returns a multidimensional array and some meta data:
+
+```json
+{
+   "pixels":[
+      [
+         "rgb(160, 144, 169)",
+         "rgb(130, 114, 137)",
+         "rgb(85, 108, 128)",
+         "rgb(229, 244, 253)"
+      ],
+      [
+         "rgb(208, 205, 220)",
+         "rgb(162, 152, 149)",
+         "rgb(150, 158, 173)",
+         "rgb(123, 137, 152)"
+      ],...
+   ],
+   "meta":{
+      "cols":4,
+      "rows":5,
+      "title":"Starry Night, Van Gogh"
+   }
+}
+```
+
+## Examples
+
+[![Demo 1](public/screengrabs/thumbs/demo_1.png)](public/screengrabs/demo_1.png)
+[![Demo 3](public/screengrabs/thumbs/demo_3.png)](public/screengrabs/demo_3.png)
+[![Demo 4](public/screengrabs/thumbs/demo_4.png)](public/screengrabs/demo_4.png)
+[![Demo 2](public/screengrabs/thumbs/demo_2.png)](public/screengrabs/demo_2.png)
+[![Demo 6](public/screengrabs/thumbs/demo_6.png)](public/screengrabs/demo_6.png)
+[![Demo 7](public/screengrabs/thumbs/demo_7.png)](public/screengrabs/demo_7.png)
+[![Demo 5](public/screengrabs/thumbs/demo_5.png)](public/screengrabs/demo_5.png)
+[![Demo 9](public/screengrabs/thumbs/demo_9.png)](public/screengrabs/demo_9.png)
+[![Demo 10](public/screengrabs/thumbs/demo_10.png)](public/screengrabs/demo_10.png)
+[![Demo 11](public/screengrabs/thumbs/demo_11.png)](public/screengrabs/demo_11.png)
+[![Demo 12](public/screengrabs/thumbs/demo_12.png)](public/screengrabs/demo_12.png)
+[![Demo 13](public/screengrabs/thumbs/demo_13.png)](public/screengrabs/demo_13.png)
+[![Demo 14](public/screengrabs/thumbs/demo_14.png)](public/screengrabs/demo_14.png)
+[![Demo 15](public/screengrabs/thumbs/demo_15.png)](public/screengrabs/demo_15.png)
+[![Demo 16](public/screengrabs/thumbs/demo_16.png)](public/screengrabs/demo_16.png)
+[![Demo 17](public/screengrabs/thumbs/demo_17.png)](public/screengrabs/demo_17.png)
+[![Demo 18](public/screengrabs/thumbs/demo_18.png)](public/screengrabs/demo_18.png)
+[![Demo 19](public/screengrabs/thumbs/demo_19.png)](public/screengrabs/demo_19.png)
+[![Demo 20](public/screengrabs/thumbs/demo_20.png)](public/screengrabs/demo_20.png)
+[![Demo 21](public/screengrabs/thumbs/demo_21.png)](public/screengrabs/demo_21.png)
+[![Demo 22](public/screengrabs/thumbs/demo_22.png)](public/screengrabs/demo_22.png)
+
+## License
+
+This project is licensed under the [unlicense](https://unlicense.org/).
diff --git a/index.js b/index.js
@@ -6,6 +6,7 @@ const app = express()
 const cors = require('cors')
 const path = require('path');
 app.use(cors())
+app.use(express.static(path.join(__dirname, '/public')));
 const port_number = process.env.PORT || 6451
 
 
@@ -41,7 +42,7 @@ async function makePixels(imageURL, cols = 32) {
     const currentRandomImage = randomImage();
 
     // If no image url passed, just show one of the demo images
-    const fileOrUrl = imageURL ? encodeURI(imageURL) : path.join(__dirname + '/static/art/' + currentRandomImage.file);
+    const fileOrUrl = imageURL ? encodeURI(imageURL) : path.join(__dirname + '/public/art/' + currentRandomImage.file);
 
     // Set col min/max
     if(cols > 64) {
@@ -113,9 +114,9 @@ app.get('/api', async (req, res) => {
 // Serve index.html
 // -----------------------------------------------------------------------------
 
-app.get('/', async (req, res) => {
-    res.sendFile(path.join(__dirname + '/static/index.html'));
-})
+  app.get('/', (req, res) => {
+      res.send('Hello World!');
+  });
 
 // -----------------------------------------------------------------------------
 // Listen

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "colorpixel",
+  "name": "pixelartist",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",

diff --git a/static/art/botticelli-venus.jpg → public/art/botticelli-venus.jpg b/static/art/botticelli-venus.jpg → public/art/botticelli-venus.jpg
diff --git a/static/art/da-vinci-mona-lisa.jpg → public/art/da-vinci-mona-lisa.jpg b/static/art/da-vinci-mona-lisa.jpg → public/art/da-vinci-mona-lisa.jpg
diff --git a/static/art/hokusai-tsunami.jpg → public/art/hokusai-tsunami.jpg b/static/art/hokusai-tsunami.jpg → public/art/hokusai-tsunami.jpg
diff --git a/static/art/hopper-nighthawks.jpg → public/art/hopper-nighthawks.jpg b/static/art/hopper-nighthawks.jpg → public/art/hopper-nighthawks.jpg
diff --git a/static/art/magritte-pipe.jpg → public/art/magritte-pipe.jpg b/static/art/magritte-pipe.jpg → public/art/magritte-pipe.jpg
diff --git a/static/art/magritte-son-of-man.jpg → public/art/magritte-son-of-man.jpg b/static/art/magritte-son-of-man.jpg → public/art/magritte-son-of-man.jpg
diff --git a/static/art/picasso-old-guitarist.jpg → public/art/picasso-old-guitarist.jpg b/static/art/picasso-old-guitarist.jpg → public/art/picasso-old-guitarist.jpg
diff --git a/static/art/riley-shadowplay.jpg → public/art/riley-shadowplay.jpg b/static/art/riley-shadowplay.jpg → public/art/riley-shadowplay.jpg
diff --git a/static/art/van-gogh-starry-night.jpg → public/art/van-gogh-starry-night.jpg b/static/art/van-gogh-starry-night.jpg → public/art/van-gogh-starry-night.jpg
diff --git a/static/art/vermeer-pearl-earring.jpg → public/art/vermeer-pearl-earring.jpg b/static/art/vermeer-pearl-earring.jpg → public/art/vermeer-pearl-earring.jpg
diff --git a/static/art/wood-american-gothic.jpg → public/art/wood-american-gothic.jpg b/static/art/wood-american-gothic.jpg → public/art/wood-american-gothic.jpg
diff --git a/static/favicon.ico → public/crap/favicon.ico b/static/favicon.ico → public/crap/favicon.ico
diff --git a/public/crap/meta-1200x628.png b/public/crap/meta-1200x628.png
diff --git a/static/crap/mona.json → public/crap/mona.json b/static/crap/mona.json → public/crap/mona.json
diff --git a/static/crap/new-mona.json → public/crap/new-mona.json b/static/crap/new-mona.json → public/crap/new-mona.json
diff --git a/static/crap/pearl_earring.json → public/crap/pearl_earring.json b/static/crap/pearl_earring.json → public/crap/pearl_earring.json
diff --git a/static/crap/pearl_earring.png → public/crap/pearl_earring.png b/static/crap/pearl_earring.png → public/crap/pearl_earring.png
diff --git a/static/index.html → public/index.html b/static/index.html → public/index.html
@@ -4,11 +4,32 @@
     <meta charset="UTF-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <link rel="icon" href="favicon.ico" />
+    <link rel="icon" href="/crap/favicon.ico" />
     <title>Pixel Artists by Blackspike.com</title>
     <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/anime.min.js"></script>
 
+    <meta name="description" content="A toy API to convert any bitmap image in to RBA colours!">
+
+    <!-- Google / Search Engine Tags -->
+    <meta itemprop="name" content="Pixel Artists by Blackspike.com">
+    <meta itemprop="description" content="A toy API to convert any bitmap image in to RBA colours!">
+    <meta itemprop="image" content="https://pixel-artist.herokuapp.com/crap/meta-1200x628.png">
+
+    <!-- Facebook Meta Tags -->
+    <meta property="og:url" content="http://pixel-artist.herokuapp.com">
+    <meta property="og:type" content="website">
+    <meta property="og:title" content="Pixel Artists by Blackspike.com">
+    <meta property="og:description" content="A toy API to convert any bitmap image in to RBA colours!">
+    <meta property="og:image" content="https://pixel-artist.herokuapp.com/crap/meta-1200x628.png">
+
+    <!-- Twitter Meta Tags -->
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:title" content="Pixel Artists by Blackspike.com">
+    <meta name="twitter:description" content="A toy API to convert any bitmap image in to RBA colours!">
+    <meta name="twitter:image" content="https://pixel-artist.herokuapp.com/crap/meta-1200x628.png">
+
+
     <style>
       :root {
         --mw: 610px;

diff --git a/public/screengrabs/demo_1.png b/public/screengrabs/demo_1.png
diff --git a/public/screengrabs/demo_10.png b/public/screengrabs/demo_10.png
diff --git a/public/screengrabs/demo_11.png b/public/screengrabs/demo_11.png
diff --git a/public/screengrabs/demo_12.png b/public/screengrabs/demo_12.png
diff --git a/public/screengrabs/demo_13.png b/public/screengrabs/demo_13.png
diff --git a/public/screengrabs/demo_14.png b/public/screengrabs/demo_14.png
diff --git a/public/screengrabs/demo_15.png b/public/screengrabs/demo_15.png
diff --git a/public/screengrabs/demo_16.png b/public/screengrabs/demo_16.png
diff --git a/public/screengrabs/demo_17.png b/public/screengrabs/demo_17.png
diff --git a/public/screengrabs/demo_18.png b/public/screengrabs/demo_18.png
diff --git a/public/screengrabs/demo_19.png b/public/screengrabs/demo_19.png
diff --git a/public/screengrabs/demo_2.png b/public/screengrabs/demo_2.png
diff --git a/public/screengrabs/demo_20.png b/public/screengrabs/demo_20.png
diff --git a/public/screengrabs/demo_21.png b/public/screengrabs/demo_21.png
diff --git a/public/screengrabs/demo_22.png b/public/screengrabs/demo_22.png
diff --git a/public/screengrabs/demo_3.png b/public/screengrabs/demo_3.png
diff --git a/public/screengrabs/demo_4.png b/public/screengrabs/demo_4.png
diff --git a/public/screengrabs/demo_5.png b/public/screengrabs/demo_5.png
diff --git a/public/screengrabs/demo_6.png b/public/screengrabs/demo_6.png
diff --git a/public/screengrabs/demo_7.png b/public/screengrabs/demo_7.png
diff --git a/public/screengrabs/demo_8.png b/public/screengrabs/demo_8.png
diff --git a/public/screengrabs/demo_9.png b/public/screengrabs/demo_9.png
diff --git a/public/screengrabs/thumbs/demo_1.png b/public/screengrabs/thumbs/demo_1.png
diff --git a/public/screengrabs/thumbs/demo_10.png b/public/screengrabs/thumbs/demo_10.png
diff --git a/public/screengrabs/thumbs/demo_11.png b/public/screengrabs/thumbs/demo_11.png
diff --git a/public/screengrabs/thumbs/demo_12.png b/public/screengrabs/thumbs/demo_12.png
diff --git a/public/screengrabs/thumbs/demo_13.png b/public/screengrabs/thumbs/demo_13.png
diff --git a/public/screengrabs/thumbs/demo_14.png b/public/screengrabs/thumbs/demo_14.png
diff --git a/public/screengrabs/thumbs/demo_15.png b/public/screengrabs/thumbs/demo_15.png
diff --git a/public/screengrabs/thumbs/demo_16.png b/public/screengrabs/thumbs/demo_16.png
diff --git a/public/screengrabs/thumbs/demo_17.png b/public/screengrabs/thumbs/demo_17.png
diff --git a/public/screengrabs/thumbs/demo_18.png b/public/screengrabs/thumbs/demo_18.png
diff --git a/public/screengrabs/thumbs/demo_19.png b/public/screengrabs/thumbs/demo_19.png
diff --git a/public/screengrabs/thumbs/demo_2.png b/public/screengrabs/thumbs/demo_2.png
diff --git a/public/screengrabs/thumbs/demo_20.png b/public/screengrabs/thumbs/demo_20.png
diff --git a/public/screengrabs/thumbs/demo_21.png b/public/screengrabs/thumbs/demo_21.png
diff --git a/public/screengrabs/thumbs/demo_22.png b/public/screengrabs/thumbs/demo_22.png
diff --git a/public/screengrabs/thumbs/demo_3.png b/public/screengrabs/thumbs/demo_3.png
diff --git a/public/screengrabs/thumbs/demo_4.png b/public/screengrabs/thumbs/demo_4.png
diff --git a/public/screengrabs/thumbs/demo_5.png b/public/screengrabs/thumbs/demo_5.png
diff --git a/public/screengrabs/thumbs/demo_6.png b/public/screengrabs/thumbs/demo_6.png
diff --git a/public/screengrabs/thumbs/demo_7.png b/public/screengrabs/thumbs/demo_7.png
diff --git a/public/screengrabs/thumbs/demo_8.png b/public/screengrabs/thumbs/demo_8.png
diff --git a/public/screengrabs/thumbs/demo_9.png b/public/screengrabs/thumbs/demo_9.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.36.56.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.36.56.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.37.31.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.37.31.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.37.57.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.37.57.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.38.19.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.38.19.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.38.26.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.38.26.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.38.51.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.38.51.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.39.02.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.39.02.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.39.39.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.39.39.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.40.02.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.40.02.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.40.11.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.40.11.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.40.36.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.40.36.png
diff --git a/static/screengrabs/Screen Shot 2021-02-01 at 11.40.52.png b/static/screengrabs/Screen Shot 2021-02-01 at 11.40.52.png
diff --git a/static/screengrabs/botticelli-venus.png b/static/screengrabs/botticelli-venus.png
diff --git a/static/screengrabs/da-vinci-mona-lisa.png b/static/screengrabs/da-vinci-mona-lisa.png
diff --git a/static/screengrabs/hokusai-tsunami.png b/static/screengrabs/hokusai-tsunami.png
diff --git a/static/screengrabs/hopper-nighthawks.png b/static/screengrabs/hopper-nighthawks.png
diff --git a/static/screengrabs/magritte-pipe.png b/static/screengrabs/magritte-pipe.png
diff --git a/static/screengrabs/magritte-son-of-man.png b/static/screengrabs/magritte-son-of-man.png
diff --git a/static/screengrabs/picasso-old-guitarist.png b/static/screengrabs/picasso-old-guitarist.png
diff --git a/static/screengrabs/riley-shadowplay.png b/static/screengrabs/riley-shadowplay.png
diff --git a/static/screengrabs/van-gogh-starry-night.png b/static/screengrabs/van-gogh-starry-night.png
diff --git a/static/screengrabs/vermeer-pearl-earring.png b/static/screengrabs/vermeer-pearl-earring.png
diff --git a/static/screengrabs/wood-american-gothic.png b/static/screengrabs/wood-american-gothic.png