husmusen-php

This is an implementation of Husmusen in PHP. Description from mushuset/husmusen:

Husmusen (the house mouse) is an inventory managment system protocol for museums and other institutions to publish information about their items and inventory for the public viewing. Husmusen aims to be as simple as possible, while still offering functionality that is important or even required. This is an example implementation of the protocol. That means that the code hopefully will be easy to read and understand, as well as contain helpful comments. Although Husmusen is technically only aimed at Swedish institutions (for now), all comments and code will be in English, simply because I think it is a hot mess to have the code in English and comments in another language. The UI for a control panel example that is included is in Swedish though.

Requirements

Husmusen-PHP requires:

• PHP version 8 (Installation guide)
• composer (a dependency/package manager for PHP)
• mariadb or mysql

How to obtain a MariaDB server?

There are two ways: host yourself or buy hosting from someone else. Various web hotels provide MariaDB hosting, but for testing I recommend hosting a server locally yourself, as that is free. See the links below for your platform:

• Windows
• Arch Linux
• Ubuntu
• Fedora

If I didn't mention your platform you can probably just search for how to install mariadb <my-platform> where you replace <my-platform> with your platform.

Setting up a development environment

Step 1: Obtaining the source code

To setup a development environment, simply clone the repository:

git clone https://github.com/mushuset/husmusen-php

Tip

You can also download a ZIP file by clicking the green button above where it says Code ▼ and then clicking on Download ZIP. (Or by simple clicking on this link.)

Step 2: Installing dependencies

After you have obtained the source code, enter the root directory of the project.

To install all the dependencies, simply run the following command:

composer install

Step 3: Creating a .env file

For the server to work properly, a .env file is needed. To create one, simply copy the contents of .env.example into .env.

Step 4: Generating the APP_KEY and running the server

Generate an app key with the following command:

php artisan key:generate

The app key will be used to sign JWTs (JSON Web Tokens).

The easiest way to run a server for development purposes is to use the included artisan script/command. Simply run:

php artisan serve

Tip

If you want, you can specify port and host for the server with --port=12345 (change 12345 to whatever port you want) and --host=0.0.0.0. Setting the --host to 0.0.0.0 is useful if you want to reach your development server from more than just localhost (127.0.0.1). You can also use -vvv to get more verbose output. (However, I believe that I've never seen this make a difference...)

Step 5: First time setup

Before you start developing on Husmusen, you should make sure your database connection is established and the tables necessary for Husmusen's operation are created.

To do this visit /setup on your development instance of Husmusen. Most likely you will find it at localhost:8000/setup (127.0.0.1:8000/setup). This is assuming you haven't specified another port, if you have, replace 8000 with your port.

Now, on the setup page follow the instructions (written in Swedish), but DO NOT click the button on step 6! Since you are creating a development environment you don't want to set the instance up as a production environment.

Step 6: You are now ready to develop

You are now done with the setup and you can start working on development.

Setting up a production environment

Step 1, 2, 3: Same as development environment

The first three steps are the same as for setting up a development environment, so follow steps 1–3 above.

Also, generate an APP_KEY with command provided in step 4 of "Setting up a development environment".

Step 4: Copying the project to your server

Now, copy all the files to your server to publish it.

This will be different depending on what web hotel provider you use or if you host the server yourself.

Step 5: Point your domain to Husmusen

This may also be different depending on web hotel provider or http server software.

The basics of it, however, is to point your domain (or subdomain) to the public-folder.

For Apache (a common http server) that should be all you have to do; the .htaccess-file in there should take care of the rest.

Step 6: First time setup

Follow step 5 under "Setting up a development environment". This step is the same except for the last part! Now you must click the button confirming that your setup is completed. Else anyone else can visit the setup page and create their own admin user and subsequently delete your entire database!