Giter Club home page Giter Club logo

appbuild's Introduction

Appbuild

Build Status

Host your iOS/Android apps for an easy installation on allowed user devices.

Features

  • Admin/user interface to manage your apps, builds and users
  • Available languages: English, French
  • Token protected applications (your build files aren't exposed to the internet and download links expire after a few minutes)
  • X-Sendfile support to download builds more efficiently
  • API (still in beta) to access data from somewhere else than the admin interface

Glossary

  • Application (or app): app general info, bound to several builds
  • Build: application version which can be downloaded and installed on a device
  • User: account identified by login and password, needed to be able to see applications and builds
  • Downloader: user who can only download builds of application he has access to
  • Admin: user who can create new applications/builds and manage the ones he has access to
  • SuperAdmin: user who can do everything (including adding SuperAdmins)

Installation

Appbuild is a "simple" Symfony 3.3 application.

Server requirements

  • Linux (it may works on Windows/macOS but you can't blame us if it doesn't)
  • php 5.6.19+ (php 7+ is recommended)
  • MySQL (it should also work using MariaDB, if not => please let us know)
  • Node.js along with npm (it works great with npm 5.7.1 for instance)
  • HTTP server supporting PHP (such as nginx + php-fpm, etc.)

Application setup

From your server (preferably not as root):

# copy sources from GitHub
cd /var/www
git clone https://github.com/LinkValue/Appbuild.git
cd Appbuild

# configure application
# by copying "app/config/parameters.yml.dist" to "app/config/parameters.yml"
# and editing "app/config/parameters.yml" to fit your context

# install dependencies and assets
# a Makefile (see https://www.gnu.org/software/make) is present to build the project from sources,
# so just run the following command:
make prod-deploy

Notice that you'll probably also need to setup correct file permissions on the var directory, see this guide to know what you can do.

HTTP server configuration

The HTTP server configuration looks like any other Symfony application, just keep in mind the following points:

  • https is required to download iOS applications (if you don't want to pay for a SSL certificate, we suggest to use Certbot which is a Let's Encrypt wrapper to generate official SSL certificates)
  • you may want to increase the max upload size (either in PHP and HTTP server configuration) to be able to upload large build files
  • X-Sendfile feature is supported to download protected build files, therefore it's recommended to configure your HTTP server to use it, if you don't, PHP will serve these files instead (which will increase memory usage)

More documentation for specific HTTP servers:

API documentation

WARNING

This API is still in BETA, it may be strongly updated. Please be really careful before updating this project if you were already using the API.

/WARNING

Before using the API, you must read this documentation about how to be authenticated on the API side.

Contributing

See our CONTRIBUTING guide

appbuild's People

Contributors

aikrice avatar jmlamodiere avatar loicpe9 avatar oliboy50 avatar raphael-trzpit avatar shinmen avatar thomasleduc avatar valentincoulon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

appbuild's Issues

Refacto du déploiement du projet

Actuellement, les sources liées au déploiement sont trop propre à notre environnement.
Il faudrait mettre ça à jour pour réellement avoir un projet open source.

Add token authorizations on file download links

Why

File download links can't be protected by user authentication because, for iOS applications, this is Apple servers which use these links... User =! Apple
However, security is very important on these links because file downloading is the main point of this application.

How

Generate a unique expirable token when a user want to download a build, then use this token (as query param) with the file download link to verify that the user has access to the file.
=> No more session needed. Apple will use the download link with a valid token.

The token should expire 10min later.

API public pour checker la nouvelle version d'un build

  • Faire une API qui prenne en parametre un numero de version et renvoie un lien si une nouvelle version est disponible, rien sinon
    le but etant coté mobile d'afficher une popup pour signifie qu'il y a une nouvelle MAJ de dispo

Allow users to change the application language

Why

The whole application is currently available in English and French, but currently we have to edit the URL to be able to change language.

How

  • Add a button in the top bar to let the user change the current application language.
  • The last chosen language should be saved for the current user (in database).
  • The application language should follow the following rules:
    • The user is not logged in, he is redirected to the login page with the application default language (where he can already change the application language).
    • The user just logged in, we don't know what is his preferred language, we save the current language as his preferred language.
    • The user is logged in, we know what is his preferred language, the application language is the user preferred language.

Update USAGE documentation

Why

The documentation is way to light to allow newcomers to use this project.

How

Update the USAGE part of the documentation.

Remove the ability of streaming file while downloading

Because

  • it makes code soooo crappy
  • it will help fixing a bug (when you rename an application, you probably won't be able to download previously attached builds on iOS)
  • we're not even sure that it works on iOS 🤦‍♂️

[Front] Change current build ready to upload by a new one

for now, if we choose a build via the form or by dragging, its working but if we want to change it by a new one, it fails whith: 'You can't upload more than 1 build at the same time'. I agree with it but normally it suppose to change the old one by the new one if we want to upload a new one.

Add an image to an application

Permettre l'ajout d'une image retaillée par le serveur en 192*192 et affiché sur la liste des applications

En plus du BO, l'image sera également utilisée dans le manifest pour la voir lors de son téléchargement sur le device.

[BUG] - Build fantome apres masquage

J'ai crée un build puis j'ai supprimé ce build, il n'est plus dispo dans l'ecran des builds de l'app mais il est toujours disponible sur la home et en telechargement

Be able to send mails when a new build is available

En tant qu'utilisateur je souhaite recevoir un mail de notifications contenant un lien de telechargement vers un nouveau build (look n feel contenant le logo de l'app, le nom de l'app, la version et le commentaire associé)

[Evol]liste de build sur la home

En tant qu'utilisateur, je souhaiterai avoir seulement le dernier build de disponible pour une application sur l'ecran de la liste des app et non pas la liste de builds entiere (qui est deja dispo ailleurs)

Allow link in comment to be clickable

When I add a http:// link in the Comment field, it is not recognize as a link and not clickable.

I wish that, when a http link is detected in this field to be rendered as a link and be clickable.

Api for uploading a build.

Need to be authenticated.
Need to be attached to an existing app
Need a response for success of failure
Need a multipart format POST with this data:

POST /application/3/build
header auth
file: binary
{"comment": "some comments",
"version": "version"}
only admin token should upload a build
header, file, version must be mandatory, comment optionnal

response:
HTTP1.1 status_code
{"error": "reason",}
if success, entity response
{"buildId": id, ...}

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.