https://github.com/signor1/gym-nex
A landing page (one page website) for gym built with react-typescript, tailwindcss and vite
https://github.com/signor1/gym-nex
Last synced: about 1 year ago
JSON representation
A landing page (one page website) for gym built with react-typescript, tailwindcss and vite
- Host: GitHub
- URL: https://github.com/signor1/gym-nex
- Owner: Signor1
- Created: 2023-08-02T16:34:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-02T16:52:19.000Z (almost 3 years ago)
- Last Synced: 2025-04-02T02:01:42.344Z (about 1 year ago)
- Language: TypeScript
- Size: 7.39 MB
- Stars: 22
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gym Landing Page - React and TypeScript
This is a gym landing page built using React and TypeScript, aimed at showcasing the gym's services and attracting potential customers. It features a modern and responsive design, providing an excellent user experience across various devices.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
To get a copy of this project up and running on your local machine, follow the installation instructions provided below.
## Prerequisites
Before proceeding with the installation, make sure you have the following prerequisites:
- Node.js (v14.x.x or higher)
- npm (v6.x.x or higher) or yarn (v1.x.x or higher)
## Installation
1. Clone the repository to your local machine:
```bash
git clone https://github.com/your-username/gym-landing-page.git
cd gym-landing-page
```
2. Install the project dependencies:
Using npm:
```bash
npm install
```
Or using yarn:
```bash
yarn install
```
## Usage
To start the development server, run the following command:
Using npm:
```bash
npm start
```
Or using yarn:
```bash
yarn start
```
The application will now be accessible at `http://localhost:3000/` in your web browser.
## Features
- Responsive design for seamless viewing on desktops, tablets, and mobile devices.
- Interactive components and animations to enhance user engagement.
- Integration with external APIs for displaying gym class schedules, promotions, etc.
- TypeScript for type checking and enhanced code maintainability.
- BMI calculator.
## Technologies Used
- React - JavaScript library for building user interfaces.
- TypeScript - Superset of JavaScript that adds static typing to the language.
- HTML5 - Markup language for structuring web pages.
- TailwindCSS - CSS framework for designing web pages.
- Vite - a frontend tool that is used for building fast and optimized web applications.
## Contributing
We welcome contributions from the community to improve this project further. To contribute, please follow our [Contribution Guidelines](CONTRIBUTING.md).
## Demo
[View Demo](https://gym-nex.vercel.app/)