Giter VIP home page Giter VIP logo

aya's Introduction

Project Aya: the globally-distributed waifu repository

Project Aya is not your typical booru. It's designed to be simple, minimal, and only focus on what matters most - the images.

Aya was created to leverage the current trend with web development - which is the serverless web application trend. It allows websites to be more efficient with cost and ultimately would future-proof the platform by splitting a what would be a monolithic system for the API into a series of split functions that only executes when needed.

We also made the UI much more simpler and modern compared to contemporaries, giving it a more professional, but simple look that is easy to get on to.

image

And to top it off, we don't rely on S3 or any vendor-specific object storage, we use IPFS to host our content, this makes sure your images are available, even if Project Aya goes down.

Contributing

For now, we're still in early stages, but we accept contributions both small and large. Keep in mind we already have the UI designed (just not implemented yet), so if you want to change something in the UI, consult Ayane Satomi - the project proponent, if you want to change something (opening an issue before doing something with the UI's overall look and feel works as well).

If you want to test what works currently, follow the instructions below.

You will need the following first to get started:

  • SauceNAO API Key
  • MongoDB Database URL (a local one would work!)
  • Reddit OAuth secrets

you will need to set them as environment variables (we make use of environment variables heavily so we can deploy on Vercel) - consult lib/database.ts and lib/saucenao.ts for the environment variable naming.

With that done, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result. Hopefully nothing breaks. If it does, go ahead and open an issue because that's clearly not intended.

Deploy on Vercel

The easiest way to deploy Aya is to use the Vercel Platform from the creators of Next.js.

Check out Vercel's Next.js deployment documentation for more details.

Copyright

Copyright © 2019 Ayane Satomi, Ovyerus, et al. Licensed under MIT.

This is a Next.js project bootstrapped with create-next-app.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.