Merge pull request #374 from nishiki-tech/develop

Release v1.0.0
nishiki-tech · Mar 25, 2024 · c728648 · c728648
2 parents e34604f + ebe5530
commit c728648
Show file tree

Hide file tree

Showing 134 changed files with 2,349 additions and 479 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -10,3 +10,4 @@ postcss.config.js
 commitlint.config.js
 docs
 coverage
+scripts
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,30 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    # The location of the package manifests (package.json)
+    directory: '/'
+    target-branch: 'develop'
+    versioning-strategy: 'increase'
+    schedule:
+      interval: 'daily'
+      time: '08:00'
+      timezone: 'Canada/Pacific'
+    commit-message:
+      # Prefix all commit messages with "npm: "
+      prefix: 'build'
+    reviewers:
+      - 'nishiki-tech/frontend-reviewer'
+
+  - package-ecosystem: 'github-actions'
+    # Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
+    directory: '/'
+    target-branch: 'develop'
+    schedule:
+      interval: 'daily'
+      time: '08:00'
+      timezone: 'Canada/Pacific'
+    commit-message:
+      # Prefix all commit messages with "npm: "
+      prefix: 'ci'
+    reviewers:
+      - 'nishiki-tech/frontend-reviewer'
diff --git a/.github/workflows/pr_check.yml b/.github/workflows/pr_check.yml
@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Get Source Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
@@ -25,7 +25,7 @@ jobs:
           cache: 'npm'
 
       - name: Cache npm
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -48,7 +48,7 @@ jobs:
 
     steps:
       - name: Get Source Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
@@ -59,7 +59,7 @@ jobs:
           cache: 'npm'
 
       - name: Cache npm
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nishiki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,29 +1,173 @@
-# Welcome to Nishiki
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="./src/assets/images/logos/logo_horizontal_primary_black_text.svg" />
+    <source media="(prefers-color-scheme: dark)" srcset="./src/assets/images/logos/logo_horizontal_primary_white_text.svg" />
+    <img src="./src/assets/images/logos/logo_horizontal_primary_black_text.svg" />
+  </picture>
+</div>
 
-<!-- TODO: Add a welcome message here -->
-<!-- ISSUE: #279 -->
+<br>
+
+<p align="center"><strong>An app for tracking and sharing food inventories within groups for better pantry management.</strong></p>
+
+<p align="center">Nishiki simplifies group food management by offering features for tracking, categorizing, and sharing food inventories, ensuring that households, roommates, and friends can seamlessly coordinate grocery shopping and pantry organization, leading to smarter consumption and less waste.</p>
+
+<br>
+
+<div align="center">
+  <img src="./public/images/screenshots/app_screenshot_signin.png" height="400">
+  <img src="./public/images/screenshots/app_screenshot_groups.png" height="400">
+  <img src="./public/images/screenshots/app_screenshot_group_single.png" height="400">
+  <img src="./public/images/screenshots/app_screenshot_foods.png" height="400">
+</div>
+
+<br>
+
+## Repository Structure
+
+Nishiki is composed of three main repositories, each serving a unique purpose within the application's ecosystem:
+
+<table>
+  <tr>
+    <th>Repository</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/nishiki-tech/nishiki-frontend" target="_blank"><strong>nishiki-frontend</strong></a></td>
+    <td><strong>This repository.</strong> It hosts the front-end code that shapes the app's user interface and interaction design.</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/nishiki-tech/nishiki-backend" target="_blank"><strong>nishiki-backend</strong></a></td>
+    <td>Contains all back-end and infrastructure code, covering server logic, database operations, and API services.</td>
+  </tr>
+  <tr>
+    <td width="200px"><a href="https://github.com/nishiki-tech/nishiki-documents" target="_blank"><strong>nishiki-documents</strong></a></td>
+    <td>Maintains GUI documentation code, including a project guide developed with Docusaurus and a Web API specification using OpenAPI.</td>
+  </tr>
+</table>
+
+## Tech Stack
+
+- Language: [TypeScript](https://www.typescriptlang.org/)
+- Framework: [Next.js 14](https://nextjs.org/) (with [App Router](https://nextjs.org/docs/app))
+- Styling: [Tailwind CSS](https://tailwindcss.com/)
+- Components: [shadcn/ui](https://ui.shadcn.com/) ([Radix UI](https://www.radix-ui.com/primitives))
+- Form Handling: [Zod](https://zod.dev/), [React Hook Form](https://react-hook-form.com/)
+- Linting/Formatting: [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [Commitlint](https://commitlint.js.org/)
+- Testing: [Jest](https://jestjs.io/)
+- Authentication: [Amazon Cognito](https://aws.amazon.com/cognito/), [AWS Amplify](https://aws.amazon.com/amplify/)
+- CI/CD: [GitHub Actions](https://github.com/features/actions), [Vercel](https://vercel.com/docs)
+- Monitoring: [Vercel](https://vercel.com/docs)
+
+## Documentation
+
+Visit [https://nishiki-tech.github.io/nishiki-documents](https://nishiki-tech.github.io/nishiki-documents/project-document/) to view the full documentation.
 
 ## Getting Started
 
 Please refer to the [Setup Documentation](./docs/SETUP.md) for instructions on how to set up the development environment locally.
 
+## Community
+
+The Nishiki community can be found on [GitHub Discussions]() where you can ask questions, voice ideas, and share your projects with other people.
+
+To chat with the team or other community members, you can join the Nishiki [Discord](https://discord.gg/kZ9kZE8dcP) server.
+
+Do note that our [Code of Conduct](./docs/CODE_OF_CONDUCT.md) applies to all Nishiki community channels. Users are highly encouraged to read and adhere to them to avoid repercussions.
+
 ## Contributing
 
 If you are interested in contributing to Nishiki, please refer to the [Contributing Guidelines](./docs/CONTRIBUTING.md) for more information.
 
 We are looking for contributors who can actively contribute to this project. If you are interested, please feel free to reach out to us.
 
-## Our Discord Server
+### Good First Issues:
 
-We have a Discord server for this project. You can join the server by clicking [here](https://discord.gg/kZ9kZE8dcP). Feel free to ask any questions or discuss anything related to the project.
+We have a list of [good first issues](https://github.com/nishiki-tech/nishiki-frontend/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22) that contain issues that are relatively easy to solve and are a good starting point for newcomers.
+
+<br>
 
 ## Authors
 
-- Kota Kawaguchi (@kotaaaa)
-- Nick Y. Ito (@nick-y-ito)
-- Kanta Sakai (@kanta1207)
-- Shuhei Ota (@ShoeheyOt)
+<table>
+  <tr>
+    <td width="80px" align="center">
+      <img src="https://avatars.githubusercontent.com/u/25422441?v=4" width="50" height="50" alt="Kota Kawaguchi" >
+    </td>
+    <td width="150px"><strong>Kota Kawaguchi</strong></td>
+    <td width="200px"><a href="https://github.com/kotaaaa" target="_blank">@kotaaaa</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-frontend" target="_blank">nishiki-frontend</a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/99148565?v=4" width="50" height="50" alt="Nick Y. Ito" >
+    </td>
+    <td ><strong>Nick Y. Ito</strong></td>
+    <td><a href="https://github.com/nick-y-ito" target="_blank">@nick-y-ito</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-frontend" target="_blank">nishiki-frontend</a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/99339182?v=4" width="50" height="50" alt="Kanta Sakai" >
+    </td>
+    <td><strong>Kanta Sakai</strong></td>
+    <td><a href="https://github.com/kanta1207" target="_blank">@kanta1207</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-frontend" target="_blank">nishiki-frontend</a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/142355969?v=4" width="50" height="50" alt="Shuhei Ota" >
+    </td>
+    <td><strong>Shuhei Ota</strong></td>
+    <td><a href="https://github.com/ShoeheyOt" target="_blank">@ShoeheyOt</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-frontend" target="_blank">nishiki-frontend</a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/43802663?v=4" width="50" height="50" alt="Taro Hirohata" >
+    </td>
+    <td><strong>Taro Hirohata</strong></td>
+    <td><a href="https://github.com/hitohata" target="_blank">@hitohata</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-backend" target="_blank">nishiki-backend</a>,
+      <a href="https://github.com/nishiki-tech/nishiki-documents" target="_blank">nishiki-documents</a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/70570221?v=4" width="50" height="50" alt="Shuhei Ota" >
+    </td>
+    <td><strong>Yuki Taniguchi</strong></td>
+    <td><a href="https://github.com/taniguchiiqqq" target="_blank">@taniguchiiqqq</a></td>
+    <td>
+      <a href="https://github.com/nishiki-tech/nishiki-backend" target="_blank">nishiki-backend</a>,
+      <a href="https://github.com/nishiki-tech/nishiki-documents" target="_blank">nishiki-documents</a>
+    </td>
+  </tr>
+</table>
+
+<br>
+
+## License
+
+This project is licensed under the terms of the [MIT License](./LICENSE).
+
+<br>
+<br>
+<br>
 
-<!-- TODO: Add License Section -->
-<!-- ISSUE: #233 -->
-<!-- ## License -->
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="./src/assets/images/logos/logo_horizontal_primary_black_text.svg" />
+    <source media="(prefers-color-scheme: dark)" srcset="./src/assets/images/logos/logo_horizontal_primary_white_text.svg" />
+    <img width="150" src="./src/assets/images/logos/logo_horizontal_primary_black_text.svg" />
+  </picture>
+</div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,3 +10,4 @@ postcss.config.js @@
     commitlint.config.js
     docs
     coverage
+    scripts