ARCS'24

Technologies Used:

• React: A powerful JavaScript library for building user interfaces.
• Vite: A next-generation frontend tooling. It's fast and efficient, perfect for modern web development.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• PostCSS: A tool for transforming CSS with JavaScript plugins.
• ESLint: Code linting to maintain consistent code quality.
• Prettier: Code formatting to ensure a consistent code style.

Getting Started

Prerequisites

make sure to install these for your OS if not already!

• Node.js (>= 20.0.0)
• npm (>= 10.0.0)

Installation

1. Clone the repository:

   git clone https://github.com/IEEECS-VIT/arcs24-frontend/
   cd arcs24-frontend

2. Install dependencies:

   npm install

Running the Development Server

To start the development server, run:

npm run dev

Open your browser and navigate to http://localhost:5173 to see the application in action.

Building for Production

To build the application for production, run:

npm run build

The built files will be located in the dist directory.

Linting and Formatting

To lint your code, run:

npm run lint

To format your code, run:

npm run format

Project Structure

The project structure is as follows:

react-vite-app-template/
├── index.html
├── package.json
├── postcss.config.js
├── public/
│   └── vite.svg
├── README.md
├── src/
│   ├── App.jsx
│   ├── index.css
│   └── main.jsx
├── tailwind.config.js
└── vite.config.js

• index.html: HTML template.
• package.json: Project metadata and dependencies.
• postcss.config.js: PostCSS configuration file.
• public/: Contains static assets.
  • vite.svg: Vite logo used in the project.
• README.md: Project documentation.
• src/: Contains the main source code for the React application.
  • App.jsx: The main App component.
  • index.css: Global CSS styles.
  • main.jsx: The entry point of the application.
• tailwind.config.js: Tailwind CSS configuration file.
• vite.config.js: Vite configuration file.