Skip to content

Codepoints/Codepoints.net

Repository files navigation

Codepoints.net

This is the code that powers Codepoints.net. You can find a short primer in the codepoints.net/index.php file on how the code flows.

Feel free to open issues at the bug tracker or contact us via Twitter: @CodepointsNet or Mastodon: @codepoints@typo.social.

See the re-use statement on codepoints.net for licensing and attribution information.

Setting up your own local instance

Get the latest database dump from dumps.codepoints.net and feed it in a MySQL database. Then create in this folder (next to this README.md) a file db.conf with this content (replace values with your database credentials):

[clientreadonly]
password=mysql-password
user=mysql-user
database=mysql-database

Install the dependencies using Composer (click here to learn how to get Composer):

composer install

Presto! Your local copy of codepoints.net is ready! To get the site running, you can use PHP’s built in development server:

php -S localhost:8000 -t codepoints.net bin/devrouter.php

or, if you like, alternatively

make serve

In both cases, your local codepoints.net clone is reachable under localhost:8000.

Development Shell

To quickly experiment with some PHP code, run this command:

make shell

This starts a PHP command-line session with all required libraries autoloaded. The variable $db contains an already active PDO instance pointing to your database.