FRBCat web
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
server
www
.zenodo.json
CITATION.cff
LICENSE
README.md
app.json
package-lock.json
package.json
server.js
webpack.config.js

README.md

DOI

frbcat-web

This is the web frontend to the FRB Catalogue. This catalogue contains up to date information for the published population of Fast Radio Bursts (FRBs). The catalog connects to a postgres database, which is defined in the frbcatdb python package. For detailed information on the database format, see the frbcatdb package, or directly the create table script.

Configuration:

frbcat-web has two configuration files.

  • server/config.js

    This file contains the postgres connection string. Modify it to connect to your postgres installation and table. The connectionstring has the following format: 'postgres://someuser:somepassword@somehost:someport/somedatabase'

    In addition, the file contains a link to the CSV location at Zenodo, e.g. https://doi.org/10.5281/zenodo.xxxxxxxx

  • server.js

    This file contains the express web server configuration. Here you can define the port the server is running on.

For further details on how to tune the express server for performance in a production environment see the expressjs homepage. This link contains information on how to set the NODE_ENV to production for different systems and how to make sure the server gets automatically restarted if it crashes.

Installation:

To install frbcat-web, please follow the following steps. First we need to install the dependencies of frbcat-web using the following commands:

  npm ci

Next, we build the package using:

  npm run webpack

Running the express server with frbcat-web:

To start the express server with frbcat-web loaded use the following command:

  npm run start