Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 3.53 KB

README.md

File metadata and controls

54 lines (37 loc) · 3.53 KB
Raw

hapijs.com

This is the home of hapijs.com.

Lead Maintainer: Nathan LaFreniere

hapijs.com is sponsored by &yet with a very special thanks to packet for providing our hosting.

Running/developing

  • First, obtain a token from github here

  • Copy the config/default.json file to config/local.json and put your token in the githubToken field of local.json. NOTE: Please do not commit the file that contains your real github token. That would make it public and allow anyone to look at this repo and use your token as though they were you.

  • Run the following commands

npm install
make
npm start

You may now visit http://localhost:3000 in your browser to view the site.

The server also runs a file watcher that will automatically rebuild content when files are changed.

Note: for committing you will need to include the public/* files that are generated during the make process. The deploy does not do the make.

Add a translation for the tutorials

In the directory lib/tutorials we have some directories with the name of the languages translated, to add a new translation, simply add a new folder in the lib/tutorials with your translation. An Example, if you translate the tutorials, to Brazilian Portuguese, you must use the pt_BR as the name of the directory. Inside the directory pt_BR, you need to follow the same struture we use in en_US, with all tutorials separated in markdown files and an index.js file that's export the tutorials and the titles. After finish the translations, you also need add your translation in the index.js file inside lib/translations.

Plugins

hapijs.com maintains a list of community-created plugins here. If there are any plugins you have created or one you use often that isn't listed please send a pull request. Please note the existing categories, but if your plugin does not fit one feel free to create your own. Please keep the plugins in alphabetical order to be fair to all contributors.

Community

Using hapi? We'd love to hear from you and list your project in our community listing. You can get your project or company added in a few steps:

  1. Fork the hapijs.com repository
  2. Add your logo to the public/img folder. It should be in png format, at least 300 pixels wide. The name should follow the format logo-<yourcompanyname>.png.
  3. Add an entry to the bottom of the hash in lib/community.js including:
    • url: Your company or project's url.
    • logo: The unqualified filename of the logo you added above.
    • description: a short (~300 characters) user quote, describing your hapi user experience.
    • person: used for quote attribution
    • height / width: Used to control the image rendering size - use one or both of these to make your logo render correctly.
  4. Submit a pull request.