kappanjoe/findadoc-web

Front-end repository for Find a Doc, Japan

Find a Doc, Japan

🎃 Hacktober friends! Please check out CONTRIBUTING 🎃

Front-end Repository

🧭 Mission

Connecting people in Japan to the healthcare services they need, in the languages they need.

🔭 Vision

We want to provide free, accessible, and quality healthcare information in multiple languages.

What is this repo?

This is the open-source, public repository for the findadoc.jp website! We welcome support and contributions :)

Have a look at the CONTRIBUTING and CODE_OF_CONDUCT to learn more about how to get started and where we could use your help.

Tech used

• Typescript
• Vue 3
• Nuxt 3
• Pinia
• Node.js version 16.18
• Yarn
• Vue-router
• ohMyFetch

Code Style

• ESLint

Getting started developing

# install dependencies
$ yarn install

# set up husky
$ yarn prepare

# For Development, start a dev server with hot reloading at localhost:3000
$ yarn dev

Testing a production build

# Generate the production bundle
$ yarn build

# Launch production server
$ yarn start

Folder Structure

assets/

The assets directory contains our uncompiled assets such as Stylus or Sass files, images, or fonts. Here's more information about the usage of this directory in the the documentation.

components/

The components directory contains our Vue.js components. Components make up the different parts of our page and can be reused and imported into the pages, layouts and even other components. Here's more information about the usage of this directory in the documentation.

layouts/

Used for building the common templates of the news articles. Here's more information about the usage of this directory in the documentation.

pages/

Contains all the pages of the site. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically. Here's more information about the usage of this directory in the documentation.

static/

This directory contains our static files. Each file inside this directory is mapped to /. Example: /static/robots.txt is mapped as /robots.txt. Here's more information about the usage of this directory in the documentation.

stores/

Contains Pinia store files for state management and data fetching.