Boost is a application to help running clubs on the registration process of their races. This project is a voluntary initiative, from members of the club and other contributors. It is open source because that's the most efficient way to guarantee the maintenance of the system in the long run. This is a community initiative openned to everyone who wants to contribute with ideas, code, documentation, fixes and tests. Other running clubs can also use this application without restrictions. The only requirement imposed by the GPL license is that, all modifications to the code must adopt the same license, therefore, equally open source.
These instructions target those who want to contribute to the project. After following these steps, you will be able to run Boost locally for development purposes, but the same instructions don't apply to a server-side production installation because of security concerns. If you like Boost and want to use it for your running club, please contact me and I can assist you on your plans.
Make sure the following software are installed, configured and running in your system.
- Git: a distributed version control system.
- Erlang Bean: the latest Elang programming language runtime.
- Elixir: the latest Elixir programming language runtime.
- PostgreSQL: an open source relational database.
- VirtualEnv: a tool to isolate Python environments.
We don't intent to explain how to install them here, but you can find vast content on the Internet about their installation and configuration.
The first step is to clone the source code locally. For that, create a folder for the project and use Git to download the code:
$ mkdir -p ~/python/projects $ cd ~/python/projects $ git clone https://github.com/htmfilho/boost.git
git clone creates a directory named
boost and downloads inside the application code as well as the entire history of changes. The next step is to create a virtual environment for the project.
$ cd ~/elixir/projects/boost $ createdb boost $ createuser boost_usr -P # Enter password for new role: secret # Enter it again: secret $ psql -d boost # grant connect on database boost to boost_usr; # revoke connect on database boost from public; # alter user boost_usr createdb; # \q
The database was created and configured as expected by the application for development purpose. The same procedure is not suitable for production.
To run the application:
$ cd ~/python/projects/boost
The application is available at: http://localhost:8000.