Skip to content

Note taking app with automatic audio to text conversion made with React.

Notifications You must be signed in to change notification settings

felipefa/react-notes

Repository files navigation

React Notes

React Notes is a web app that allows users to create notes focused on user accessibility. The key feature of this app is to create notes using the Web Speech API.

This project is a React application built with TypeScript. It uses Vite as a build tool, PostCSS for processing CSS, and Tailwind CSS for utility-first CSS styling. The project is set up with ESLint for linting and follows certain coding style guidelines.

Technologies Used

Project Structure

  • src/: Contains the TypeScript and React source files for the application.
  • public/: Contains static assets that will be served by Vite.
  • vite.config.ts: Configuration file for Vite.
  • tsconfig.json: Configuration file for TypeScript.
  • postcss.config.js: Configuration file for PostCSS.
  • tailwind.config.js: Configuration file for Tailwind CSS.
  • .eslintrc.cjs: Configuration file for ESLint.

How to Run the Project

Before running the project, make sure you have Node.js and npm installed on your machine.

  1. Clone the repository to your local machine.
  2. Navigate to the project directory.
  3. Install the project dependencies with npm install.
  4. Start the development server with npm run dev.

Please refer to the scripts section in the package.json file for more commands related to building and serving the application.