Giter Club home page Giter Club logo

findadoc-frontend's Introduction

Website Netlify Status GitHub License W3C Validation ESLint

Find a Doc JAPAN

Join our slack!

ko-fi

If you have more issues with submodules, please check out the wiki troubleshooting page

Getting started / Running the app

Install dependencies

yarn

Serve with hot reload at localhost:3000

yarn dev

Build for production and launch server

yarn build
yarn start

NOTE: To see current environment you are connected to, check the console logs.

For detailed explanation on how things work, check out Nuxt.js docs.

Internationalization (i18n)

Under the hood, this project uses nuxt/i18n and vue-i18n.

The locale files are managed through the localization repo and released as an npm package that can be updated. Here is the process for adding new translation keys:

  1. Clone the findadoc-localization repo
  2. Edit the locales/en.json to contain the new keys.
  3. If you know another language, feel free to add the same key and translation to the appropriate locale file. Omit if you don't know it; we use English as the fallback language so nothing will break.
  4. Make a pull request to the localization repo and wait for it to be merged to main
  5. Update the package inside package.json using yarn upgrade @ourjapanlife/findadoc-localization to get the latest keys imported
  6. Run yarn again
  7. Make your change in this repo with the new i18n keys and submit your PR ๐ŸŽ‰

Troubleshooting

Make sure you have node v16.4.2 installed before installing the dependencies.

If you don't have it, the easiest way to manage node versions is by using nvm. Read the Install NVM guide.

After installing it, you need to install the correct node version:

nvm install 16.4.2

After the installation, just use it:

nvm use

findadoc-frontend's People

Contributors

theyokohamalife avatar ann-kilzer avatar renderf0x avatar ermish avatar dependabot[bot] avatar mdboop avatar psychicnoodles avatar imteekay avatar johntitor2036 avatar rossellafer avatar bridgetrosefitz avatar claudiofreitas avatar amar-prabhu-29 avatar jsoref avatar 2moon avatar shoebsd31 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.