https://github.com/siddharthvp/toolforge-node-app-base

Base for creating a node.js app hosted on Toolforge
https://github.com/siddharthvp/toolforge-node-app-base

Last synced: about 2 months ago
JSON representation

Base for creating a node.js app hosted on Toolforge

• Host: GitHub
• URL: https://github.com/siddharthvp/toolforge-node-app-base
• Owner: siddharthvp
• License: mit
• Created: 2020-05-23T17:12:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T21:36:21.000Z (almost 2 years ago)
• Last Synced: 2024-07-09T20:20:54.687Z (3 months ago)
• Language: JavaScript
• Size: 558 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# toolforge-node-app-base

Base for creating a node.js app hosted on Toolforge, per https://wikitech.wikimedia.org/wiki/Help:Toolforge/Web#node.js_web_services

## How to use

- Git clone this repository and put it in your Toolforge tool's $HOME/www/js directory

- Write your server application in the `server.js` file. Remove the boilerplate code that you don't need.

- Put the static assets in the `static` directory. These will be served as-is.

- Modify the package.json file filling in your details. Modify the copyright notice on the LICENSE file.

- Put your account and toolforge database access credentials in credentials.json, if they're being used.

   - Database access credentials are available from `replica.my.cnf` file in the tool's $HOME.

   - This file is set to be ignored by git. Either you can create this file directly on the Toolforge host, or you can securely transfer it using scp or rsync (linux/mac) or winscp or pscp (Windows).

- Run `npm test` to test your app locally. This sets up a [nodemon](https://www.npmjs.com/package/nodemon) server on port 3000, which should behave the same way as your tool would on `yourtoolname.toolforge.org`.

   - Use relative URLs to make any API calls to your tool's backend, and for any static loads of resources, so that they work correctly on the test environment as well.

   - But note that Toolforge database accesses will not work correctly on your local. See this [help page](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Database#Connecting_to_the_database_replicas_from_your_own_computer) to connect to database replicas from your own computer.

- Run `npm run deploy` while in Toolforge to start the webservice, or to restart it after a code change.

- To check the logs of your live application running in the Kubernetes container, enter `npm run logs`