https://github.com/victor-0x29a/legends-wiki

A front for RPG wiki.
https://github.com/victor-0x29a/legends-wiki

chakra-ui cypress i18n react storybook typescript usequery

Last synced: 20 days ago
JSON representation

A front for RPG wiki.

• Host: GitHub
• URL: https://github.com/victor-0x29a/legends-wiki
• Owner: victor-0x29a
• Created: 2024-04-26T11:10:12.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T11:50:25.000Z (4 months ago)
• Last Synced: 2025-01-15T21:41:26.089Z (27 days ago)
• Topics: chakra-ui, cypress, i18n, react, storybook, typescript, usequery
• Language: TypeScript
• Homepage:
• Size: 1.32 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Getting started

This project is for a wiki of [Primordial Legends, RPG](discord.gg/primordial-legends).

Using [React.js](https://react.dev/) generated by [ViteJs](https://vitejs.dev/) using [Typescript](https://www.typescriptlang.org/).

# How to install?

For Linux/Windows/Mac:

- Install the latest version from [Node.Js](https://nodejs.org/en)

- Install the latest version from [NPM](https://www.npmjs.com/)

And now, after install the npm, let's install the [yarn](https://yarnpkg.com/) (Other package manager) running the command:

- `npm i -g yarn`

When the [yarn](https://yarnpkg.com/) is installed, let's go install all the dependencies from project running the command:

- `yarn install`

# How to run the project?

Run: `yarn dev`

# How to run the [storybook](https://storybook.js.org/)?

Run: `yarn storybook`

# How to run the tests?

Run: `yarn test`

And to run the cypress, install all dependencies from [cypress docs](https://docs.cypress.io/guides/getting-started/installing-cypress) and run `yarn cy:open`

# Conventional commits for this project

For more clarity in your actions and a good coexistence, use this pattern to name your commits.

- Feat: a new feature

- Patch: update in a exists feature

- Fix: for a fix in a exists feature

- Style: warnings from lint or adjusts in code

- Refactor: upgrades in code, for example: new adjust to more performance

# Linter

Please, install on your vscode the [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension, the [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [prettier eslint](https://marketplace.visualstudio.com/items?itemName=rvest.vs-code-prettier-eslint).

Now, configure your vscode for use the "Default javascript, typescript" as your default formatter.