docs: Add initial README content

This commit is contained in:
James Graham
2020-03-05 10:12:20 +00:00
parent 40afbc1908
commit 118ce6228f

16
README.md Normal file
View File

@@ -0,0 +1,16 @@
# BRECcIA-Mapper (provisional name)
BRECcIA-Mapper is a web app to collect and explore data about the relationships between researchers and their stakeholders on large-scale, multi-site research projects.
TODO motivations, usage, license
## Technology
This project is written in Python using the popular [Django](https://www.djangoproject.com/) framework.
An [Ansible](https://www.ansible.com/) playbook is provided which is designed for deployment on RHEL7 or CentOS7 Linux systems. This installs and configures:
- MySQL
- Nginx
- Django + BRECcIA-Mapper
TODO deployment instructions