ljvmiranda921 / sprites-as-a-service Goto Github PK

• Parameter Description
• Changelog (how to do this?)
• Code samples
• Add URLs for parts that need to have URLs (/documentation, links to Licenses, Github links, buy me a coffee)

How to do the Changelog

Description: this is the first release v1 of Sprite-as-a-Service, notable changes:
... Still not sure how to do it

Use this for matplotlib: https://gist.github.com/illume/1f19a2cf9f26425b1761b63d9506331f

Background

Now that we've written the meat of the website, it's now time to just add all of the text aesthetics. Sure, there might be some sort of logic in a way (e.g., pulling the latest release from Github and copying over the Changelog), but ideally these should be simple textboxes.

Todo

(Unimplemented) BaseHeader.vue

• TheHeroHeader: "Sprite-as-a-Service"
• SubHeader: "Generate 8-bit Avatars using Cellular Automata!"

SpriteController.vue

• SpriteControllerCTA: "Like it, love it? Leave us a star on Github!"

SnippetDisplay.vue

• SnippetDisplayDocs: Parameter description table
• SnippetDisplayCTA: "Read more in the documentation"

(Unimplemented) TechnicalNotes.vue

• TechnicalNotesLicensing.vue
• TechnicalNotesChangelog.vue: just manually write this for now

RuntimeWarning: More than 20 figures have been opened. Figures created through the pyplot interface (matplotlib.pyplot.figure) are retained

I think this may be a good entry for Behance, assuming that you get to execute and implement this properly. You can start talking about your inspiration, how you designed various components (logo, buttons, sliders) and more. The goal is to talk about your design process and how you achieved that.

• Extinction rate (slider?)
• Stasis rate (slider?)
• Size (multi-choice)
• Query (short text)

API Docs link to Redocs, About is another page that links (in the future) on your Behance writeup, postscript blog post, and a short description of your motivation and whatnot

Backend: Python with FastAPI
Frontend: VueJS

What's still missing and needs to be updated:

• How to deploy
• Update docker-compose.yml instructions for local dev
• Add badges??
• Better README

• What is this about?
• How to deploy?
• How to run locally?
• How tu run tests?

https://itch.io/docs/creators/html5

lgtm!

I want to mount the service on github pages like you do, mount sprites-as-a-service/ on https://ljvmiranda921.github.io/, how can I do that?

• Do not hard-code it?
• Use environmental variables if necessary

We can improve the generated colors we some bit of Hue shifting. I'm not sure how I can implement this in matplotlib's colormap. Ideally, we shouldn't be choosing three random colors. Instead, we just generate a base color, then shift the hues 2-3 times. (One from the left and the other on the right).

This is definitely a nice-to-have, and I might do this in the future, not in POC

It may be nice to have something like this: https://cloud.google.com/bigquery/docs/quickstarts/quickstart-client-libraries#client-libraries-install-ruby

We can implement this via a Tab: https://www.w3schools.com/howto/howto_js_tabs.asp
This should definitely take the config as an input, then outputs the code snippet based on the viewed language. Our code snippets can then be: cURL, Go, Python, Javascript

Also, in our design, we planned to have it side-by-side with the explanation of each parameter. So on the left pane we have the parameter explanations, then on the right pane we have the tablist. The Issue for the parameter explanations will be covered by #24

• SpriteConfig
• BaseURL

Currently you have multiple versions scattered in your

backend/**/main.py
frontend/**/package*.json

Not sure if bumpversion will work here, but maybe you can setup a script file to do a bumpversion for you

https://github.com/bansal-io/pattern.css

https://github.com/GoogleCloudPlatform/github-actions/blob/master/example-workflows/cloud-run/.github/workflows/cloud-run.yml

User should be able to click a button, and it will generate an 8-bit avatar

Figma design: https://www.figma.com/file/kivIPyumCZxwb7b1jLChFH/Wireframe?node-id=0%3A1

If Behance is more of a creator's way of walking through his inspiration and design process, the blogpost should be more of a postscript. It should answer the following questions:

• Why did you decide to do this?
• What's the motivation behind all the work?
• What have you learned in Frontend web dev and design?
• Any new learnings along the way? (e.g. ideas being in the adjacent possible, some sort of serendipity, meta-learning or how I learn to learn)

Follow these instructions: https://www.uvicorn.org/deployment/

• ext_rate: extinction
• stasis_rate: survival

Hi! The icons generated by this application are very nice 😄

I'm like to use a few of them as avatars for projects in GitLab/Codeberg (GitHub-like sites where you can associate an avatar to a repository).

I'm not sure where I should put the attribution as required by CC Attribution, can you give some hints if this is an allowed thing to do?

Related to #6