Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.37 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.37 KB
Raw

🤖 ChatGPT Study With Me AI FE

📚 Front-end repository for ChatGPT Study With Me AI.

🚀 Getting Started

To get started with this project, you should have Node.js and npm installed on your machine. Clone the repository and run npm install to install the necessary dependencies.

npm install
npm run start

💻 Available Scripts

In the project directory, you can run:

npm start Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

npm test Launches the test runner in the interactive watch mode.

npm run build Builds the app for production to the build folder.

npm run storybook Runs Storybook for developing and testing components.

npm run build-storybook Builds Storybook as a static web application.

npx run serve-storybook Serves Storybook as a static web application.

npm run lint Lints the code using ESLint.

npm run lint:fix Lints the code using ESLint and automatically fixes issues.

npm run format Formats the code using Prettier.

📁 Folder Structure

The code is organized into the following directories:

src/components/ This directory contains the React components used throughout the application.

src/pages/ This directory contains the React components that represent pages of the application.

src/stories/ This directory contains the Storybook stories for testing the components.