Giter VIP home page Giter VIP logo

website's Introduction

Verdaccio website

backers discord MIT

https://www.verdaccio.org

Documentation

Documentation files are hosted under /docs folder.

Running the website locally

You should run all these tasks from the inner /website folder.

The commands you need to use for serving the site locally:

  • yarn install - installs all dependencies.
  • yarn start - runs a local server that launches the Verdaccio documentation site on http://localhost:3000/

Running the website as a Docker container

The Verdaccio documentation website can run as a Docker container (useful for offline usage of the website).

In order to run the website on Docker, use the following commands (run commands from the outer /website folder):

docker build -t verdaccio-docs:4.0.1 . - building the Verdaccio documentation site image docker run -p <host-port>:3000 verdaccio-docs:4.0.1 - starting the container, listening on for your choice.

Saving the image for later offline usage is available by building the container and then using docker save verdaccio-docs:4.0.1 > <tar-name>.tar and loading it afterwards with docker load < <tar-name>.tar .

tested on ubuntu 18.04.2 with Docker 18.09.6

Translation

Verdaccio is powered by crowdin platform that provides Verdaccio a free open source license.

How to help with translations

  1. Create an account at Crowdin https://crowdin.com/project/verdaccio (It is free)
  2. Choose your language
  3. Choose a file
  4. Suggest a translation

Crowdin works with 2 sort of roles, Translator and Proofreader. All users are Translator by default. Any suggestion should be approved by a proofreader for each language.

If you want to be a Proofreader send me a private message over crowdin.

If you are willing to translate and language is not available, feel free to requested with a ticket.

Privates messages here https://crowdin.com/profile/juanpicado

Translation stats the last year

screen shot 2019-02-22 at 6 58 54 am

Contributing

Read the contribution guidelines before start.

website's People

Contributors

verdacciobot avatar juanpicado avatar ayusharma avatar danielruf avatar dunxen avatar sergiohgz avatar jamesgeorge007 avatar honzahommer avatar jinliming2 avatar dependabot[bot] avatar priscilawebdev avatar mrlannigan avatar ventycz avatar kopax avatar alexjurkiewicz avatar alessiodionisi avatar kgeis avatar lkraav avatar martin31821 avatar owenvoke avatar troyanskiy avatar mrwacky42 avatar shawntoubeau avatar tomgrill avatar fer0x avatar willsmythe avatar zkochan avatar millerick avatar reviewher avatar metrakit avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.