Skip to content

Commit

Permalink
Fixing requirements for new CI apps
Browse files Browse the repository at this point in the history
  • Loading branch information
ray-codeinstitute committed Aug 12, 2020
1 parent 2c763a7 commit 99d8905
Show file tree
Hide file tree
Showing 9 changed files with 201 additions and 202 deletions.
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ RUN apt update && \
# openedx requirements
vim iputils-ping dnsutils telnet \
gettext gfortran graphviz graphviz-dev libffi-dev libfreetype6-dev libgeos-dev libjpeg8-dev liblapack-dev libpng12-dev libsqlite3-dev libxml2-dev libxmlsec1-dev libxslt1-dev lynx nodejs npm ntp pkg-config \
libbz2-dev \
&& rm -rf /var/lib/apt/lists/*

WORKDIR /openedx/edx-platform
Expand Down
101 changes: 26 additions & 75 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,92 +1,43 @@
This is the core repository of the Open edX software. It includes the LMS
(student-facing, delivering courseware), and Studio (course authoring)
components.

Installation
------------
This is the CodeInstitute fork of OpenEDX.

Installing and running an Open edX instance is not simple. We strongly
recommend that you use a service provider to run the software for you. They
have free trials that make it easy to get started:
https://openedx.org/get-started/
It contains a Dockerfile geared towards creating a simple image that can be deployed in a cluster.
It also contains some extra apps written by CodeInstitute.

If you will be modifying edx-platform code, the `Open edX Developer Stack`_ is
a Docker-based development environment.

If you want to run your own Open edX server and have the technical skills to do
so, `Open edX Ubuntu 16.04 64-bit Installation`_ has instructions to install
it on an existing Ubuntu 16.04 server.
Developer Setup
---------------

.. _Open edX Developer Stack: https://github.com/edx/devstack
.. _Open edX Ubuntu 16.04 64-bit Installation: https://openedx.atlassian.net/wiki/display/OpenOPS/Native+Open+edX+Ubuntu+16.04+64+bit+Installation

Build docker image

License
-------
Deploy locally using docker-compose
- add www.myopenedx.com to /etc/hosts

The code in this repository is licensed under version 3 of the AGPL
unless otherwise noted. Please see the `LICENSE`_ file for details.
Run tests

.. _LICENSE: https://github.com/edx/edx-platform/blob/master/LICENSE
Debug local cluster

Development against local cluster

More about Open edX
-------------------

See the `Open edX site`_ to learn more about the Open edX world. You can find
information about hosting, extending, and contributing to Open edX software. In
addition, the Open edX site provides product announcements, the Open edX blog,
and other rich community resources.
Cleaning up local data directories (./edxdata)

.. _Open edX site: https://openedx.org

Documentation
-------------
Breakdown of local dev services
-------------------------------

Documentation can be found at https://docs.edx.org.
- LMS
- CMS
- LMS Worker
- CMS Worker
- Nginx
- MySql
- MongoDB
- Memcached
- Elasticsearch
- RabbitMQ
- SMTP (Mailhog)
- LMS DB Setup / Migrate task


Getting Help
------------

If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack team`_.

For more information about these options, see the `Getting Help`_ page.

.. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
.. _community Slack team: http://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help


Issue Tracker
-------------

We use JIRA for our issue tracker, not GitHub issues. You can search
`previously reported issues`_. If you need to report a problem,
please make a free account on our JIRA and `create a new issue`_.

.. _previously reported issues: https://openedx.atlassian.net/projects/CRI/issues
.. _create a new issue: https://openedx.atlassian.net/secure/CreateIssue.jspa?issuetype=1&pid=11900


How to Contribute
-----------------

Contributions are welcome! The first step is to submit a signed
`individual contributor agreement`_. See our `CONTRIBUTING`_ file for more
information – it also contains guidelines for how to maintain high code
quality, which will make your contribution more likely to be accepted.


Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email
[email protected].

.. _individual contributor agreement: https://openedx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf
.. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst
3 changes: 3 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh

docker build . -t edx-juniper -f Dockerfile
6 changes: 6 additions & 0 deletions db_setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/sh

docker-compose exec mysql mysql openedx -u root -parglebargle -e "CREATE DATABASE IF NOT EXISTS openedx_csmh; GRANT ALL PRIVILEGES ON openedx_csmh.* TO openedx"
docker-compose exec ci-lms ./manage.py lms migrate
docker-compose exec ci-lms ./manage.py cms migrate
docker-compose exec ci-lms ./manage.py lms migrate --database=student_module_history coursewarehistoryextended
127 changes: 0 additions & 127 deletions docker-compose.test.yml

This file was deleted.

Loading

0 comments on commit 99d8905

Please sign in to comment.