Skip to content
This repository has been archived by the owner on Sep 24, 2021. It is now read-only.

kir12/open-guidebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

open-guidebook

Motivation

Conventions of all types benefit from having some kind of mobile guidebook for displaying events. There's a bunch of apps out there which offer efforltess creation of guidebooks ... at a (pricy) cost. This project is an open-source implementation which aims to provide a free app. To further aid deployment, it will (eventually) be set up as a Docker container that you can simply plop inside a server, set it up for an event, and then destroy everything afterwards.

Requirements

  • Linux, Mac OS, WSL/Cygwin
  • Python 3.x
  • npm, and React.js

Additional Deployment Requirements:

  • Some kind of virtual private server (VPS) preferrably running Linux
  • Some kind of database (e.g. PostgreSQL, optional)

Installation Instructions

  1. git clone https://github.com/kir12/cjn-webapp.git && cd webapp
  2. python -m venv env && source env/bin/activate
  3. pip install -r requirements.txt
  4. python manage.py migrate

React/Docker -specific instructions to come soon

Sources Used

About

Open-source guidebooks for conventions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published