Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 3.48 KB

README.md

File metadata and controls

100 lines (62 loc) · 3.48 KB
Raw

The OpenPowerlifting Project

Build Status

A permanent, accurate, convenient, accessible, open archive of the world's powerlifting data. Presentation of this data is available at OpenPowerlifting.org.

Powerlifting to the People.

Contents

  1. Project Chat
  2. Licensing
  3. Development Installation

Project Chat

Project work is discussed in the OpenPowerlifting Zulip Chat. Everyone is welcome to join.

Licensing

Code Licensing

All OpenPowerlifting code is Free/Libre software under the GNU AGPLv3+.
Please refer to the LICENSE file.

Data Licensing

OpenPowerlifting data (*.csv) under meet-data/ is contributed to the public domain.

The OpenPowerlifting database contains facts that, in and of themselves,
are not protected by copyright law. However, the copyright laws of some jurisdictions
may cover database design and structure.

To the extent possible under law, all data (*.csv) in the meet-data/ folder is waived
of all copyright and related or neighboring rights. The work is published from the United States.

Although you are under no requirement to do so, if you incorporate OpenPowerlifting
data into your project, please consider adding a statement of attribution
so that people may know about this project and help contribute data.

Sample attribution text:

This page uses data from the OpenPowerlifting project, https://www.openpowerlifting.org.
You may download a copy of the data at https://gitlab.com/openpowerlifting/opl-data.

If you modify the data or add useful new data, please consider contributing
the changes back so the entire powerlifting community may benefit.

Development Installation

Fedora 40

Install dependencies:

sudo dnf install cargo rust make npm python3-beautifulsoup4 python3-flake8 ansible parallel uglify-js jemalloc

Build the project and run the server:

make
cargo run --release --bin server

Ubuntu 20.04 LTS (Focal)

Follow the instructions for Fedora, but use this alternate command for installing dependencies:

sudo apt-get install cargo rust curl make npm python3-bs4 flake8 ansible parallel uglifyjs jemalloc

Windows 10 (Native)

  1. Download and install the Build Tools for Visual Studio 2019.

    • When the installation menu appears, under the "Workloads" tab, select "C++ build tools" and press Install. A reboot will be required.

  2. Install the Rust language for Windows.

    • The default options are OK.

  3. To clone this repository locally, install GitHub Desktop. When given the option, select "Clone from URL" and enter https://gitlab.com/openpowerlifting/opl-data.git or the address to a personal fork.

  4. In the Start Menu, open the Command Prompt.

    • Navigate to the repository directory. If you used GitHub Desktop, the command is cd Documents\GitHub\opl-data.
    • Run the checker: cargo run --bin checker.

Docker

To run the server using Docker, simply build and run:

docker build -t opl .
docker run -p 8000:8000 opl

Access at http://localhost:8000/ per usual.