diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c45b66 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# LCM Website + +This is the official website for LCM, a company that provides innovative solutions for the electric vehicle industry. + +## Installation + +To get started with this project, you'll need to have Node.js and npm installed on your machine. + +1. Clone the repository: + ```bash + git clone https://github.com/your-username/lcm-website.git + ``` +2. Navigate to the project directory: + ```bash + cd lcm-website + ``` +3. Install the dependencies: + ```bash + npm install + ``` + +## Usage + +To start the development server, run the following command: + +```bash +npm run dev +``` + +This will start a local development server at `http://localhost:5173`. + +## Available Scripts + +- `npm run dev`: Starts the development server. +- `npm run build`: Builds the application for production. +- `npm run lint`: Lints the code. +- `npm run preview`: Starts a local server to preview the production build. +- `npm run predeploy`: Builds the application before deploying. +- `npm run deploy`: Deploys the application to GitHub Pages.