Archived

This repository has been archived in favour of https://github.com/Mudlet/mudlet-package-repository, which is a simpler and a more straightforward setup.

Old README below:

Mudlet Package Repo

This server will power the Mudlet package repository and serve as a reference implementation for any other person or organization which may want to host their own repository for Mudlet packages.

Want a preview? Available at http://172.105.1.54:8080 (alpha)

It is implemented using Lapis (API), which is a lua web framework that runs inside of OpenResty (API), a custom implementation of NginX. Check out the technical vision to get a sense of our development style.

We make use of the follow luarocks:

• lapis https://github.com/leafo/lapis
• bcrypt http://github.com/mikejsavage/lua-bcrypt
• i18n https://github.com/kikito/i18n.lua
• lua-resty-mail https://github.com/GUI/lua-resty-mail
• lua-mailgun https://github.com/leafo/lua-mailgun

We do not actually make use of lapis-chan, but it served as an example from which examples and inspiration were drawn: https://github.com/karai17/lapis-chan

Getting started with development

Via Docker

By choosing Docker you don't have to worry about installing and configuring the dependencies or PostgreSQL yourself.

Steps for Docker:

• Install Docker
• Install docker-compose
• Run docker-compose build to build the image.
• Run docker-compose up to run the website.
• Login with admin and supersecretadminpass.

To refresh the website, rebuild and re-run it again.

To delete all data and restart from scratch, docker-compose rm and docker volume rm mudlet-package-repo_postgres.

• If you'd like to test sending verification emails, you'll need to configure an SMTP provider (ie gmail or mailgun).

export SMTP_HOST="smtp.mailgun.org"
export SMTP_PORT="587"
export SMTP_USERNAME="postmaster@..."
export SMTP_PASSWORD="..."

Submit changes via PR, and happy hacking!

Via local development

Steps for local:

• Install OpenResty

• Install Luarocks

• sudo apt install libssl-dev (on Ubuntu)

• luarocks install lapis

• luarocks install bcrypt

• luarocks install inspect

• luarocks install i18n

• luarocks install lua-resty-mail

• Install and configure PostgreSQL. Create mudletrepo user, password, and database in plsql (instructions). Check the development config in config.lua for defaults currently in use during development.

• create a data folder (at the root of the repository)

• run lapis migrate to perform the migrations on the database and get it setup

• Setup SMTP on localhost at port 1025. You can use fakeSMTP for this as it saves the email as a .eml file and you can open it in your email client of choice - run it with java -jar fakeSMTP-2.0.jar -p 1025 -o /tmp.

Finally, start the server with run lapis server and visit http://localhost:8080 to see the page!

The code cache is currently turned off, so refreshing the page will show any changes to the code immediately.

Submit changes via PR, and happy hacking!

Translation

We are using the i18n module by kikito for internationalization. https://github.com/kikito/i18n.lua

In the static/i18n folder in the project there are several .lua files for i18n translations. If you look in en.lua all of the string keys which are in use through the site are listed, and adding the corresponding key to the de.lua file for instance will add the German translation. Then when the locale is loaded it will load the entries from the language which matches the locale set by the user. If the key isn't found in that locale (en-US for instance) then it will move to the parent locale (en in the example case). If it still doesn't find an entry for that key, it will look in the default (en in our case) and load that. TODO: Figure out getting this in crowdin like Mudlet.