Find a Doc JAPAN

Join our slack!

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