Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
api
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Pauling

General Android iOS
CircleCI BuddyBuild BuddyBuild

Pauling is an open-source solution to get a better experience with scientific posters. Authors share their poster via the Pauling web application and receive a QR code that should be added next to the poster during the session. Conference attendees use the Pauling mobile application to retrieve the poster and all its information on their mobile phone! This application has been built during a "Le lab" session:

Get it on Google Play

Installation

API (web app)

You have to navigate to the api/ folder first.

  1. Install the project dependencies:
$ make boostrap
  1. Create a local_settings.py file with your own settings:
# flask
SECRET_KEY = 'Secr3tK3yF0rD3v'

# mailer
MAIL_SERVER   = '127.0.0.1'
MAIL_PORT     = 15025
MAIL_LOGIN    = ''
MAIL_PASSWORD = ''
MAIL_USE_TLS  = False

# upload/cdn
CLOUDINARY_URL      = 'cloudinary://user:pass@account'
CLOUDINARY_BASE_URL = 'https://res.cloudinary.com/account'
  1. Start the application in development mode:
$ make dev
  1. Last but not least, apply the database migrations:
$ make flask-db-upgrade

You can now browse the application at: http://127.0.0.1:5000/.

Mobile app

You have to navigate to the mobile/ folder first.

  1. Be sure to have the React Native environment installed first, then install the project dependencies:
$ make boostrap
  1. Start a Android device of your choice. It can be a virtual device (with emulator) or a real device connected to your computer:
$ emulator @Nexus_5X_API_25_x86
  1. Start the application in development mode (Android):
$ make dev

Sketch file

We use Git LFS to track the Sketch files so that the size of the repository does not get to big too fast. Be sure to have it installed :) You can retrieve the files (if you do not have them) by fetching them:

$ git lfs fetch

Contributing

Please, see the CONTRIBUTING file.

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See the CODE_OF_CONDUCT file.

License

Pauling is released under the MIT License. See the bundled LICENSE file for details.

You can’t perform that action at this time.