Web application to launch and follow travelling books
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bookvoyage-backend
bookvoyage-frontend
.travis.yml
LICENSE
README.md

README.md

Book Voyage

Empowering books to travel | Visit our live instance here

platform preview

Build Status Python Style guide Gitter chat

Ready for a new kind of journey?

Awesome! You made it to our GitHub page 📙 🚀

We're a tribe of EDUshifters with a mission: giving books movement, and giving movements books.

Book Voyage is a web-based platform to launch and follow travelling books as they move across the globe.

This document (the README file) is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.

The first voyage

It all started with a crowdfunding campaign with a simple premise: what if we could distribute our book not in any regular fashion, but as part of a collective game? What if all books would be given to participants at a single conference, each with a final destination attached to it? What if books could travel and connect people?

This sparked us to test the theory of six degrees of separation that would exist between any two people. Instead of simply sharing ideas through a passive book, we wished to create a network of people; a movement united by having shared the ideas in our book.

This concept is a pilot that we would love to involve you in. If proven succesful, let's make sure many more book voyages will happen across the globe!

What do we need?

You! In specific, we are looking for (Angular 2+) front-end developers who are looking for a Javascript challenge in map APIs, as well as Django/Python developers to contribute to our back-end implementation.

We are very open to suggestions to extend the platform in interesting directions, so please leave a message if you have a great new feature in mind.

How to run it?

The application has two components: a front-end based on Angular and a back-end based on Django. Interaction happens through an API. Users only use the front-end; administration is performed through Django.

For Users

You will only need to run the Django server with a compiled website in it. This production version is currently not on GitHub yet. If you require it, please leave us a message in the issues.

For Developers

Backend (Django Framework)

You will find the instructions for running the back-end here.

Frontend (Angular Framework)

You will find the instructions for running the front-end here

General tips for unexperienced programmers

All these are but humble suggestions from a recent learner. You can use any major operating system, but a Linux (virtual) machine comes recommended if you want to work on the back-end. If you don't run Linux already, this virtual machine is pretty great. Using a virtual python environment also comes recommended. If you want to focus on Angular development, you may want to work in your native OS rather than a virtual machine to avoid some issues with automatic refreshing.

Get involved

If you run into any issues or would just like to get in contact with us, then join our Gitter!