Skip to content
content management and distribution system of The Open Learning Platform serlo.org
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
cypress
database Move development to docker environment (#503) Apr 27, 2017
dev-tools chore: install php-cs-fixer via composer Feb 20, 2019
dist/solr Initial commit Jan 23, 2015
docker-entrypoint-initdb.d fix(db): add missing permission Feb 20, 2019
scripts fix: don't use deprecated feature anymore Nov 8, 2018
src feat(mathjax): enable `mediawiki-texvc` extension for `\Euro` Mar 14, 2019
.editorconfig
.gitattributes
.gitignore
CHANGELOG.md feat(mathjax): enable `mediawiki-texvc` extension for `\Euro` Mar 14, 2019
CONTRIBUTING.MD Clean up README, add CONTRIBUTING Dec 8, 2015
Dockerfile
HOWTOS.md
LICENSE feat: license header script Nov 8, 2018
QUERIES.md chore: QUERIES.md Mar 5, 2019
README.md chore: update README Feb 20, 2019
UPGRADE.md
composer.json
composer.lock
cypress.json
docker-compose.dist.yml chore: install php-cs-fixer via composer Feb 20, 2019
package.json ci: fix ci Feb 20, 2019
php-cs-fixer.config.php chore: update copyright years Jan 14, 2019
phpunit.xml
prettier.config.js chore: add php-cs-fixer and prettier Nov 6, 2018
tsconfig.json Fixed errors stated in Eclipse PDT. Nov 14, 2018
yarn.lock add integration test form password restore mail Feb 1, 2019

README.md

Serlo logo

Athene2

Build status Kanban board

Installation

You need Docker, Node.js v10 and Yarn installed on your system.

Now follow the upcoming instructions.

Clone the project

# Clone the project:
$ git clone https://github.com/serlo/athene2.git
$ cd athene2

Bootstrapping the project

On Linux or macOS, just open a terminal and run the following commands:

# Copy some config files
$ cp docker-compose.dist.yml docker-compose.yml
$ cp src/config/autoload/local.dist.php src/config/autoload/local.php
$ cp src/config/autoload/develop.local.dist.php src/config/autoload/develop.local.php
$ cp src/public/htaccess.dist src/public/.htaccess

Starting docker-compose

$ yarn start

Setting up hosts

On Windows, please add

127.0.0.1 de.serlo.localhost
127.0.0.1 en.serlo.localhost

to your C:\Windows\System32\drivers\etc\hosts.txt file. Then run ipconfig /flushdns in cmd.exe and restart your browser.

On macOS:

$ sudo nano /etc/hosts

# add lines
127.0.0.1    de.serlo.localhost
127.0.0.1    en.serlo.localhost

# flush macOS DNS cache
$ sudo killall -HUP mDNSResponder

Now, open de.serlo.localhost:4567. Happy coding!

PS: de.serlo.localhost:4567 works for me in Chrome but not in FireFox. Not sure why, but if it doesn't work try a different browser.

Development

Development is straight forward, make your changes to the php files and then reload the browser. Done!

If you want to modify the assets (e.g. .css, .js files), you will also have to clone and set up https://github.com/serlo/athene2-assets. Before that, make sure you have yarn installed:

$ git clone https://github.com/serlo/athene2-assets
$ cd athene2-assets
$ yarn
$ yarn start

Furthermore, set assets_host to the url of webpack dev server in src/config/autoload/develop.local.php:

return [
    // ...
    'assets_host' => 'http://localhost:8081/'
];

Changes to the assets will automatically reload the browser.

Further resources

Most of these are outdated:

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.