Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metacpan/metacpan-web
Web interface for MetaCPAN
https://github.com/metacpan/metacpan-web
cpan hacktoberfest metacpan perl
Last synced: 2 days ago
JSON representation
Web interface for MetaCPAN
- Host: GitHub
- URL: https://github.com/metacpan/metacpan-web
- Owner: metacpan
- License: other
- Created: 2011-04-18T14:25:49.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T18:39:42.000Z (6 months ago)
- Last Synced: 2024-04-14T02:23:08.722Z (6 months ago)
- Topics: cpan, hacktoberfest, metacpan, perl
- Language: Perl
- Homepage: http://metacpan.org
- Size: 13.1 MB
- Stars: 411
- Watchers: 43
- Forks: 235
- Open Issues: 204
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://coveralls.io/r/metacpan/metacpan-web)
- [Getting Started](#getting-started)
- [Installing Manually](#installing-manually)
- [Building Static Assets](#building-static-assets)
- [Installing on macOS](#installing-on-macos)
- [Running Tests](#running-tests)
- [Running the App](#running-the-app)
- [Local Git and testing considerations](#local-git-and-testing-considerations)
- [Local Configuration Changes](#local-configuration-changes)
- [Compatibility Notes](#compatibility-notes)
# Getting Started
We strongly recommend using
[metacpan-docker](https://github.com/metacpan/metacpan-docker). This will give
you a virtual machine already configured and ready to start developing on.
If you prefer not to use Docker, the following commands will get you started:
## Installing Manually
```bash
carton install
npm install
export PATH="$(realpath ./node_modules/.bin):$PATH"
```
### Building Static Assets
```bash
npm run build
```
Without running this command you may get errors about a missing "asset map".
### Installing on macOS
If you like, you can install `carton` and `cmark` via Homebrew:
```bash
brew install carton cmark
```
On an ARM Mac you may need to install
[CommonMark](https://metacpan.org/pod/CommonMark) in the following way:
```bash
LIBRARY_PATH=/opt/homebrew/lib CPATH=/opt/homebrew/include cpm install -g CommonMark
```
If your `carton install` is having issues with SSL-related modules, you may need
to use an `OPENSSL_PREFIX`. Something like:
```bash
OPENSSL_PREFIX="/usr/local/Cellar/[email protected]/1.1.1q" carton install
```
You may need to check `/usr/local/Cellar/[email protected]` to find the latest
installed path on your system.
## Running Tests
You can use the supplied wrapper around `prove` to run tests:
```bash
./bin/prove t
```
To run the tests in parallel, add `-j8` (or however many CPUs you have) to the
`prove` command.
## Running the App
```bash
carton exec plackup -p 5001 -r
```
If you'd like to use `Gazelle` rather than the default Plack server:
```bash
carton exec plackup -p 5001 -s Gazelle -r
```
## Local Git and testing considerations
You will want to set up the supplied pre-commit Git hook like so:
```bash
./git/setup.sh
```
which causes `precious` to be run before each commit. You can manually run this
with `precious path/to/file`
## Local Configuration Changes
The back end defaults to `fastapi.metacpan.org`. Running a local API server is
optional and not required to hack on the front end. The address to the API being
used can be changed in the `metacpan_web.conf` file. Ideally you would create a
new file called `metacpan_web_local.conf` that contains
```bash
api http://127.0.0.1:5000
```
which will be loaded on top of the existing config file.
## Compatibility Notes
On Win32 (and possibly also on other platforms) when using Perl < 5.12, the
server started with plackup will generate warnings relating to date parsing.
These are caused by Plack due to a bug in the gmtime implementation and can be
removed by upgrading to Perl 5.12.