https://github.com/cyberkutti-iedc/tinkerhubsnmimt
https://github.com/cyberkutti-iedc/tinkerhubsnmimt
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cyberkutti-iedc/tinkerhubsnmimt
- Owner: cyberkutti-iedc
- License: mit
- Created: 2024-08-15T14:49:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T15:29:57.000Z (9 months ago)
- Last Synced: 2025-01-30T09:44:38.494Z (4 months ago)
- Language: Vue
- Homepage: https://tinkerhubsnmimt.vercel.app
- Size: 134 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TinkerHub SNMIMT Official Webpage
```markdown
Welcome to the official webpage for TinkerHub SNMIMT! This project includes the TinkerHub SNMIMT official website and a specialized College Bus Stop ETA (Estimated Time of Arrival) webpage. Developed in 2024 by TinkerHub SNMIMT students, this application is built using the Vue.js framework and Tailwind CSS.
## Features
- **Home Page**: Provides information about TinkerHub SNMIMT and its initiatives.
- **College Bus Stop ETA**: Displays real-time estimated arrival times for buses at the college bus stop.
- **Dark Mode**: Toggle between light and dark themes for enhanced user experience.
- **Real-Time Updates**: Live updates for current time and bus arrival times.
- **Responsive Design**: Fully responsive design that looks great on both desktop and mobile devices.
## Tech Stack
- **Vue.js**: A progressive JavaScript framework for building user interfaces.
- **Tailwind CSS**: A utility-first CSS framework for creating custom designs without having to leave your HTML.
- **Axios**: A promise-based HTTP client for making requests to the API.
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) (version 14 or higher)
- [npm](https://www.npmjs.com/) (Node package manager)
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/cyberkutti-iedc/TinkerHub-SNMIMT.git
cd your-repo
```
2. **Install dependencies**
```bash
npm install
```
3. **Run the development server**
```bash
npm run dev
```
This will start the development server and you can view the application at `http://localhost:5173`.
### Build for Production
To build the project for production, run:
```bash
npm run build
```
This will create a `dist` directory with the production-ready files.
## Project Structure
- `src/`
- `assets/` - Contains images and other static assets.
- `components/` - Reusable Vue components.
- `views/` - Vue components representing pages or views.
- `App.vue` - Root Vue component.
- `main.js` - Entry point for the Vue application.
- `public/` - Contains the static HTML file and other assets.
- `tailwind.config.js` - Tailwind CSS configuration file.
- `vue.config.js` - Vue CLI configuration file.
## Usage
- **Home Page**: Contains information about TinkerHub SNMIMT and general navigation.
- **Bus Stop ETA**: Allows users to see the current time and estimated arrival times of buses. Users can switch between different tabs to view all bus times, search for specific buses, or check buses arriving soon.
## Contributing
Contributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.
1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature-branch`)
5. Create a new Pull Request
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any questions or inquiries, please contact us at [[email protected]](mailto:[email protected]).
---
**Developed by TinkerHub SNMIMT Students, 2024**