Skip to content

Repository files navigation

GetLinked AI Hackathon Project

This is the repository for the GetLinked AI hackathon project. The project is a 3-page website built using React, TypeScript, and Sass. It utilizes the GetLinked AI contact API, registration API, and category list API.

Table of Contents

Project Overview

This project was created for the GetLinked AI hackathon. It consists of a 3-page website where users can register for the hackathon. The website allows users to input their team name, contact information, project topic, select a category, specify group size, and accept the privacy policy.

The project utilizes the following APIs:

  • Contact API: Used for contacting the organizers or administrators.
  • Registration API: Allows users to register for the hackathon.
  • Category List API: Provides a list of categories for users to choose from during registration.

Technologies Used

  • React
  • TypeScript
  • Sass (SCSS)
  • React Hook Form for form handling
  • Zod for form validation
  • @hookform/resolvers/zod for form validation resolver
  • Routing with react-router-dom
  • Axios for API requests
  • Custom hooks for API data fetching

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/your-username/getlinked-ai-hackathon.git
  2. Navigate to the project directory:

    cd getlinked-ai-hackathon
  3. Install the project dependencies:

    npm install
  4. Start the development server:

    npm start

The website should now be running locally, and you can access it in your web browser at http://localhost:3000.

Usage

To use the website:

  1. Navigate to the homepage.
  2. Click on the "Register" link to access the registration page.
  3. Fill in the registration form with your team information.
  4. Select a category from the dropdown list.
  5. Specify the group size.
  6. Accept the privacy policy by checking the checkbox.
  7. Click the "Register" button to submit your registration.

Screenshots

Screenshot 1 Screenshot 2

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear and descriptive messages.
  4. Push your changes to your fork.
  5. Create a pull request to the main branch of this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.


About

GetLinked Ai Hackathon Page

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages