https://github.com/marufk21/hackathon_app
A web application for organize and managing hackathons.
https://github.com/marufk21/hackathon_app
javascript react tailwindcss
Last synced: about 1 month ago
JSON representation
A web application for organize and managing hackathons.
- Host: GitHub
- URL: https://github.com/marufk21/hackathon_app
- Owner: marufk21
- Created: 2024-09-02T12:29:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-05T11:33:22.000Z (almost 2 years ago)
- Last Synced: 2025-04-03T08:48:36.863Z (about 1 year ago)
- Topics: javascript, react, tailwindcss
- Language: JavaScript
- Homepage:
- Size: 2.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hackathon App
A web application for managing hackathons. Built with Vite and Material UI.
## Features
- Create, edit, and delete hackathons.
- View a list of hackathons with sorting, filtering, and searching functionalities.
- Display active, upcoming, and past hackathons with appropriate information and timers.
## Technologies
- **React**: JavaScript library for building user interfaces.
- **Vite**: Fast build tool and development server.
- **Material UI**: React components that implement Google’s Material Design.
- **Tailwind CSS**: React components for customizing CSS.
## Getting Started
### Prerequisites
Ensure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/).
### Installation
1. **Clone the Repository**
```bash
git clone https://github.com/your-username/hackathon-app.git
cd hackathon-app
```
2. **Install Dependencies**
```bash
npm install
```
3. **Start the Development Server**
```bash
npm run dev
```
This will start the development server at `http://localhost:3000`. Open this URL in your browser to see the application.
## Project Structure
- **/src**: Contains all the source code.
- **/components**: Reusable React components.
- **/pages**: React components for different pages.
- **App.jsx**: Main application component.
- **index.jsx**: Entry point for the application.
- **/public**: Contains static assets like images.
- **vite.config.js**: Vite configuration file.
## Contributing
1. **Fork the Repository**
2. **Create a New Branch**: `git checkout -b feature/your-feature`
3. **Commit Changes**: `git commit -am 'Add new feature'`
4. **Push to the Branch**: `git push origin feature/your-feature`
5. **Create a Pull Request**