usage.md

Usage Guide

This guide will help you run the project locally and understand the basic workflow.

---

Tech Stack (planned)

• React + Vite (frontend framework & build tool)
• TypeScript (strongly-typed JavaScript)
• ESLint + Prettier (code quality and formatting)

This may evolve as the project grows. Any proposed changes will be discussed in Discussions.

---

Prerequisites

• Install Node.js (LTS version recommended).
• Install npm (comes with Node.js).
• (Optional) Install Git if you want to clone the repository directly.

---

Running the Project Locally

1. Clone the repository

   git clone https://github.com/OpenCodeChicago/hacktoberfest-2025-frontend.git
   cd hacktoberfest-2025-frontend

2. Copy environment variables file

   cp .env.example .env

   The API URL is set in .env as VITE_API_URL. You can use this variable in your code as import.meta.env.VITE_API_URL

3. Install dependencies

   npm install

4. Start the development server

   npm run dev

5. Open your browser and navigate to the URL printed in the terminal

   (usually http://localhost:5173)

---

Available Scripts

• npm run dev → Run the app in development mode
• npm run build → Build the app for production
• npm run preview → Preview the production build locally
• npm run lint → Run the linter to check code style

---

Workflow for Contributing

1. Fork this repository
2. Create a new branch for your feature or fix
3. Commit your changes
4. Open a Pull Request (PR) with a clear description of what you did

For more details, see CONTRIBUTING.md

---

Troubleshooting

• If you see an error like command not found: npm, make sure Node.js and npm are installed.
• If the dev server doesn’t start, try deleting node_modules and package-lock.json, then run npm install again.
• Still stuck? Ask in main Hacktoberfest Discussion or on Discord

---

⭐ Support the Project

If you find this project helpful, please consider starring it on GitHub! It helps us grow and reach more contributors.