Skip to content

SETUP.md

Latest commit

 

History

History
85 lines (56 loc) · 1.83 KB

SETUP.md

File metadata and controls

85 lines (56 loc) · 1.83 KB

Development Setup

To begin modifying the website, follow these steps:

Clone the Repository

First, clone the repository to your local machine:

git clone https://github.com/FRCTeam1277/Team-1277-Website.git
cd Team-1277-Website

Requirements

Ensure you have the following installed on your system:

  1. Node.js (version 18 or higher) and npm (Node Package Manager)

  1. Text Editor: Use a code editor like Visual Studio Code.

  2. Git: Ensure Git is installed for version control.

Install Dependencies

After cloning the repository, install the required dependencies in the project root folder:

npm install

Run the Development Server

Start the development server to test the website locally:

npm run dev

This will start the Vite development server. Open your browser and navigate to http://localhost:5173 to view the website.

Build for Production

To create a production-ready build of the website:

npm run build

The build files will be generated in the dist directory.

Preview the Build

To preview the production build locally:

npm run preview

Deploying the Website

Ensure you have the correct permissions to push changes to the repository.

Additional Notes

  • The package.json file contains all the scripts and dependencies required for the project.
  • For linting and code quality checks, you can run: 
    npm run lint
  • Use the .gitignore file to exclude unnecessary files from version control.
  • For any issues, refer to the README.md file or contact the repository maintainer.