Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 4.7 KB

README.md

File metadata and controls

126 lines (94 loc) · 4.7 KB
logo@2x

Tenryou

Tenryou is a companion website create for the action-rpg game Genshin Impact. Tenryou is intended to help players view information from the game in a visual and cohesive manner with via information pulled from various resources to provide up-to-date information with a teambuilder prototype to help you create your team.

Current Features

  • User Card Profile/Team Builder
  • Characters
  • Artifacts
  • Weapons
  • Materials
  • Achievements
  • And more...

Current Roadmap

  • Add more customization options to edit user images
  • Improve Teambuilder by migrating to a different AI and add example teams
  • TCG Support
  • Add calculator for stats, and ascension
  • Discord Bot

Development

Tenryou is create via Next.js and information is pulled using axios by these sources:

Built With

Next React TailwindCSS Vercel Framer-Motion

Prerequisites

  • Git Installed.
  • Node.js Installed.
  • Some knowledge of bash (a shell) commands (ex.: cd, ls).
  • An api key for the Team Builder Gemini or OpenAI depending on which one you choose.

Getting Started

# clone repository
git clone https://github.com/Pho86/Tenryou.git

# change directory into the repository
cd Tenryou

# install dependencies
npm i, pnpm i

# create .env.local and add a key depending on which AI wanted
touch .env.local

# run in dev mode and open in http://localhost:3000.
npm run dev, pnpm dev

# export as production static site
npm run build, pnpm build

# run e2e tests
npm run cypress:open

Screenshots

homepage page

teambuilder page

User profile page

Contributing

Contribute by reporting a bug/suggesting an enhancement

  1. Navigate to the issues page in this repository
  2. Add a new Issue and give it a clear and concise title and description. Include any other information, images, etc. that may be needed.
  3. Give it an appropriate label
  4. Thank you for your contribution!

Contribute through development,

  1. Create an issue before contributing
  2. Fork the Project
  3. Create your Feature Branch (git checkout -b Feature)
  4. Commit your Changes (git commit -m 'Add some Feature')
  5. Push to the Branch (git push origin Feature)
  6. Open a Pull Request with a clear and concise title and description.
  7. Thank you for your contribution!

License

Distributed under the MIT License.

This website and repository is not affiliated with HoYoVerse. All content and materials from the game Genshin Impact, are trademarks and copyrights of the original owners and HoYoVerse.