Skip to content

Nishiki is an app for tracking and sharing food inventories within groups for better pantry management.

License

Notifications You must be signed in to change notification settings

nishiki-tech/nishiki-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


An app for tracking and sharing food inventories within groups for better pantry management.

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.



Repository Structure

Nishiki is composed of three main repositories, each serving a unique purpose within the application's ecosystem:

Repository Description
nishiki-frontend This repository. It hosts the front-end code that shapes the app's user interface and interaction design.
nishiki-backend Contains all back-end and infrastructure code, covering server logic, database operations, and API services.
nishiki-documents Maintains GUI documentation code, including a project guide developed with Docusaurus and a Web API specification using OpenAPI.

Tech Stack

Documentation

Visit https://nishiki-tech.github.io/nishiki-documents to view the full documentation.

Getting Started

Please refer to the Setup Documentation 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 server.

Do note that our Code of Conduct 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 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.

Good First Issues:

We have a list of good first issues that contain issues that are relatively easy to solve and are a good starting point for newcomers.


Authors

Kota Kawaguchi Kota Kawaguchi @kotaaaa nishiki-frontend
Nick Y. Ito Nick Y. Ito @nick-y-ito nishiki-frontend
Kanta Sakai Kanta Sakai @kanta1207 nishiki-frontend
Shuhei Ota Shuhei Ota @ShoeheyOt nishiki-frontend
Taro Hirohata Taro Hirohata @hitohata nishiki-backend, nishiki-documents
Shuhei Ota Yuki Taniguchi @taniguchiiqqq nishiki-backend, nishiki-documents

License

This project is licensed under the terms of the MIT License.