Getting Started

Setup

First, clone the repository into your local machine:

git clone https://github.com/js-acedevs/ruoystock-app.git

or using SSH

git clone git@github.com:js-acedevs/ruoystock-app.git

After you have a clone of your project into your local machine you are ready to test the project, but first:

cd into the folder

cd ruoystock-app

Install dependencies via npm or yarn

npm install or npm i

or

yarn add

Start Application

And finally start the development server using the script below

npm run start

You can visit http://localhost:3000 to view the running application

Start the build application

To start the build application run the script below

npm run build

after that do

npm run serve

You can visit http://localhost:3000 to view the running application

Tools

1. React
2. Typescript
3. ESLint
4. Prettier
5. Husky
6. GraphQL
7. Tanstack Router
8. Tanstack Query
9. Vite
10. Mantine
11. TailwindCss

Structure

This app is structured based on atomic design patterns

Learn more

• 📁 components
  • 📁 atoms
  • 📁 molecules
  • 📁 organisms
  • 📁 templates
• 📁 config
• 📁 enums
• 📁 graphql
  • 📁 client
  • 📁 fragments
  • 📁 gen
  • 📁 hooks
  • 📁 mutation
  • 📁 query
  • 📁 subscription
• 📁 hooks
• 📁 interfaces
  • 📁 models
  • 📁 types
• 📁 pages
• 📁 styles
• 📁 utils

Available Scripts

start

Starts development server

build

Builds production version of the App

prettier

Runs prettier format

type:check

Does typescript type checking

lint

Lints all files in src folder