Giter VIP home page Giter VIP logo

orionao3's Introduction

app icon

Orion for Ao3

Orion is a mobile client for the Archive of Our Own service (AO3). Orion is written in Angular with the Ionic Framework, and is a Capacitor-compiled app.

Pre-requisites

  • Ionic Framework 5
  • node.js 12.x or higher
  • npm 6 or higher

Installation

Refer from Ionic's documentation to install Ionic.

After cloning this repository, initialize the project's directory with Ionic.

ionic init 

Then install the dependencies.

npm install 

Building the App

As this is built with Ionic Capacitor, build all components first then sync them before compiling.

ionic build
npx cap copy
npx cap sync

Capacitor does not have a native way to build using the CLI. Build it using Android Studio and/or Xcode instead.

npx cap copy android
npx cap open android

My repository doesn't currently have iOS support out-of-the-box. You can add it yourself.

npx cap add ios
npx cap copy ios
npx cap open ios

Refer to Ionic and Angular's documentation to modify and/or use this app.

Contributing

For people viewing, forking, or cloning this repository using its GitHub mirror, never report your issues or make pull requests there. These are only mirrors and are not monitored for bug reports and pull requests. Please directly make commits on GitLab so I can merge your commits.

I haven't implemented a way to actually search and browse Ao3 for this app. Reasons include Ao3's current lack of a proper API and time from my part.

Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to test code before opening a pull request as to make merging efficient and convenient for everyone. Always remember to keep your code merged with current sources as well.

License

Orion is licensed in GPLv3

orionao3's People

Contributors

tenseventy7 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.