Table of Contents

1. About The Project
   • Frontend built with
2. Current Features
3. Getting Started
   • Prerequisites
   • Installation
4. Roadmap
5. Contributing

About The Project

Jappuri is a full stack web app that aims to teach tourists about proper etiquette customs when visiting Japan. This is the repository for the frontend of the web app. For full functionality, use with the backend is required.

The project is deployed at Jappuri.app.

(back to top)

Frontend built with

• 
• 
• 
• 

(back to top)

Current Features

• Login/Sign-up with both Firebase and backend authentication
• Search bar with location type filtering
• Interactable Google Maps component
• Place component showing photos, general information and etiquette rules
• Ability to share one's experiences
• Ability to give helpfulness ratings to experiences
• Ability to check, edit, and delete one's experiences via the user dashboard

Getting Started

To get a local copy up and running follow the steps below.

Prerequisites

Acquire the latest version of npm

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Team-Strawberry-CC36/frontend.git

2. Install NPM packages

   npm install

3. Create and input your backend URL in a .env

   VITE_BACKEND_URL='ENTER YOUR API';

4. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin Team-Strawberry-CC36/frontend
   git remote -v # confirm the changes

5. Run the project

npm run dev

(back to top)

Roadmap

• Implement establishment owner features
• Reply feature to experiences
• Additional location types

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have any suggestions that could improve this project, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors: