Giter Site home page Giter Site logo

findsorguk / findsorguk-docs Goto Github PK

View Code? Open in Web Editor NEW
0.0 3.0 1.0 5.94 MB

APIGEN documentation of the findsorguk code base

Home Page: https://finds.org.uk/docs

License: GNU Lesser General Public License v3.0

HTML 99.90% JavaScript 0.10% CSS 0.01%
apigen php documentation-generator

findsorguk-docs's Introduction

The Portable Antiquities Scheme's Database source code

DOI License: GPL v3

Scheme logo

A repository for the current generation of the Portable Antiquities Scheme website. A British Museum project that encourages the voluntary recording of archaeological artefacts found by the public in England and Wales. A working version of this software can be seen at https://finds.org.uk or at https://marinefinds.org.uk and comprehensive instructions about how to install a copy can be found in the wiki.

Requirements

The database is written with a Linux operating system in mind.

Operating system requirements:

  • Recommended Ubuntu 20.04 or other LTS
  • PHP 7.4.3+
  • Solr 4.2
  • MySQL 8.0.28
  • APC Cache or equivalent
  • Curl
  • ImageMagick
  • GD
  • PDO

PHP libraries

Most of the PHP libaries are included as submodules, which will be pulled on deployment via Git on your server.

  • Zend Framework 1.12.21dev
  • Solarium 2
  • ZendX_JQuery
  • HTMLPurifier
  • EasyBib
  • mpdf
  • imagecow

Geographical boundaries

The system also makes use of converted OS boundary data in geoJSON format (also included as a submodule.) These are also maintained in a Github repository.

Search index

You will also need to install and configure SOLR for the system to be fully functioning. The schemas for this are located in our SOLR repo.

Virtual host configuration

A set of example virtual host configuration files for Apache 2.4 are available.

SSL

It is recommended that the system is configured to use https and the free service offered by Letsencrypt is ideal.

Contributing

We welcome code contributions to make this system better. Please refer to our contributing guidelines before submitting patches or new features.

Changes

A change log is now maintained by the project developers to try and explain how things are being improved.

Current development team

Previous development team

Acknowledgements

This software was built on the foundations of Oxford Arch Digital:

  • Andrew Larcombe
  • Chad
  • Kos Vankov
  • Tyler Bell
  • Vuk Trifkovic
  • Yegor Veter

The Scheme is also grateful for the contributions of Richard Wareham (Cambridge University) and Ethan Gruber (ANS).

License

The codebase is released under GPL V3.

Funded by

findsorguk-docs's People

Contributors

portableant avatar

Watchers

 avatar  avatar  avatar

Forkers

portableant

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.