https://github.com/cancelei/greenthanol-a-hackathon-website

Main learning points: The team was involved in creating an idea to present in a Hackathon. That included structuring of documents and a website, that can be seen here.
https://github.com/cancelei/greenthanol-a-hackathon-website

hackathon hackathon-project

Last synced: 17 days ago
JSON representation

Main learning points: The team was involved in creating an idea to present in a Hackathon. That included structuring of documents and a website, that can be seen here.

• Host: GitHub
• URL: https://github.com/cancelei/greenthanol-a-hackathon-website
• Owner: cancelei
• License: other
• Created: 2023-09-02T23:22:37.000Z (over 1 year ago)
• Default Branch: Main
• Last Pushed: 2023-11-27T22:01:51.000Z (about 1 year ago)
• Last Synced: 2025-01-03T07:48:42.731Z (about 1 month ago)
• Topics: hackathon, hackathon-project
• Language: CSS
• Homepage: https://cancelei.github.io/Greenthanol-a-Hackathon-Website/src/index.html
• Size: 6.59 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        




  
Greenthanol Readme - Project Repository




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Greenthanol

A hackathon project about Bioethanol was developed during a weekend by a team of 4 members.

## 🛠 Built With Love and Passion

### Tech Stack 

  Client

  


    
HTML

  


  Server

  


    
Webpack & Github Pages

  


Form Submission Service

  


    
Formspree.io

  


### Key Features 

- Presentation of the Hackathon Project

- Video Presentation

- Participants and their Roles

- Key Features of the Solution

(back to top)


## 🚀 Live Demo 

- Link

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

Download Project Files from github.

### Setup

Clone this repository to your desired folder:

### Install

Install Node Package by running:

- npm install

### Usage

- In order to use the repo you either create a branch to create new features.

- But in order to run the project use the commands below:

  - npm run build (It will create a production-ready file)

  - npm start (It will run the server on your local machine)

### Run Linters (Testing)

I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base.

So while using this repository if you need to check your work no matter if you have worked on HTML CSS, or even JS you can use the commands below.

- To run the linter test on index.html or any HTML file. Use the below command:

npx hint . 

-To run linter test on Stylesheets (CSS or sass). Use the below command:

npx Stylelint "**/*.{css,scss}"

- To run linter test on ES Lint (JS). Use the below command:

npx eslint .

### Deployment

N/A

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author Glauber Bannwart**

- GitHub: [@cancelei](https://github.com/cancelei)

- LinkedIn: [LinkedIn](https://linkedin.com/in/gbannwart)

(back to top)


## 🔭 Future Features 

All future Updates of the Project can be reflected on this website.

(back to top)


## 🙏 Acknowledgments 

- Advantage Austria

- Hackathon Organizers

## 📝 License 

This project is [MIT](./LICENSE.md) licensed.

(back to top)