Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Latest commit

 

History

History
115 lines (68 loc) · 4.37 KB

README.md

File metadata and controls

115 lines (68 loc) · 4.37 KB

Waifu Motivator Plugin Logo

Waifu Asset Management UI

A convenient administration dashboard that makes viewing, uploading, and editing the Waifu Motivator Plugin's assets.

Usage

Whenever you make any changes to any of the assets, a Sync Changes button will appear in the bottom right-hand corner of the application. The application works by keeping thing cached locally. If you where to refresh your browser before syncing your changes, you will lose any changes not synced to the appropriate bucket.

That being said, you are free to navigate to other areas of the application using the navigation side bar. Such as if you need to add a new waifu definition, after you have dropped in a bunch of new assets.

Roles

Any authenticated user has the ability to view all the assets available! However, only users in the Admin group have the ability to create, update, and delete assets.

At the moment you have the ability to:

Asset Categorization

Asset categorization enables us to define and group Waifu by the anime they appear in. If you want to tag a waifu in an asset, you'll have to create her definition inside the anime she appears in.

Edit Assets

Editing an asset allows you to:

  • Define character tags.
  • What kind of asset categories it belongs to
  • Add/update/remove any related assets
  • Add/Update the image alt.

You will not be able to change the image path after an asset has been uploaded.

Local Development

Prerequisites

About Local ENV

To avoid breaking things for our users, we have a non-prod environment.

https://waifu-motivation-assets-nonprod.s3.amazonaws.com

Assets will be uploaded to that bucket when developing locally.

React Notes

This project was bootstrapped with Create React App.

Dev Tools

Available Scripts

In the project directory, you can run:

yarn

This will install of the applications dependencies defined in the package.json at the root of this repository. You will need to run this after cloning the project.

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

AWS Amplify

This application uses the AWS Amplify platform.

Any commits to master will be automatically built and deployed to production!

Handy commands npm install -g @aws-amplify/cli amplify pull

Note: this is only needed if any of the platform needs to be updated. It is not required to do local development.

Handy links