Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 1.82 KB

README.md

File metadata and controls

85 lines (51 loc) · 1.82 KB

ThymioIA React Application

This project is a React application that integrates with TensorFlow.js and Thymio robots for interactive AI learning and control. It uses Vite as a build tool for a fast development experience.

Prerequisites

Before you begin, ensure you have installed the following on your system:

  • Node.js (v18.18.2 or newer)
  • yarn (1.22.21 or newer)

Installation

To set up the project, follow these steps:

  1. Clone the repository:
git clone https://github.com/Mobsya/ThymioIA.git
cd thymioia
  1. Install dependencies: using Yarn:
yarn
  1. Running the Development Server:

To start the development server with hot module replacement (HMR) enabled:

with Yarn:

yarn dev

This will start the Vite development server and you can view your application at http://localhost:3000.

  1. Building for Production:

To build the application for production deployment:

with Yarn:

yarn build

This will generate a dist folder in your project directory with optimized assets for deployment.

Using ESLint and Prettier

The project is configured with ESLint for linting and Prettier for code formatting. You can run the linter with:

npm run lint

Or format your code with Prettier:

npm run format

Committing Changes

This project uses Commitizen for structured commit messages. To make a commit:

yarn commit

Follow the prompts to complete your commit message.

Additional Configuration

For further customization and advanced configurations, refer to the official Vite documentation at https://vitejs.dev and the React documentation at https://reactjs.org.

Contributing

Contributions to this project are welcome! Please refer to the contributing guidelines for more details.