An open API service indexing awesome lists of open source software.

https://github.com/cancelei/capstone-m1-event-page

Main learning points: Use HTML, CSS and in later PR's use JS to generate dynamically Sections of the Website. Done while doing Microverse Coding School.
https://github.com/cancelei/capstone-m1-event-page

website

Last synced: 3 months ago
JSON representation

Main learning points: Use HTML, CSS and in later PR's use JS to generate dynamically Sections of the Website. Done while doing Microverse Coding School.

Awesome Lists containing this project

README

        


Cancelei's Capstone Project

# πŸ“— 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)

# πŸ“– Capstone Project

**Event D-HTML Page** is simple project that includes a HTML file with corresponding CSS styling, and a backend setup that includes specific linters that verify Html/CSS files for auto-merge capability. It also has autogenerating parts that use Javascript with objects.

## πŸ›  Built With Love and Passion

### Tech Stack

Client

Server


  • N/A

Database


  • N/A

### Key Features

- ** HTML & JS**
- ** CSS**
- ** Linters to automatically check availability to merge on to the main(head) branch.**

(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 other to use the repo you either to 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 or 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

- Improve UX Experience for the Event
- Add form
- Add Newsletter Subscription form

(back to top)

## 🀝 Contributing

N/A

## ⭐️ Show your support

N/A

(back to top)

## πŸ™ Acknowledgments

Original design idea by Cindy Shin in Behance.BEHANCE

Icons by Surang (Agricultura e jardinagem Γ­cones criados por surang - Flaticon)

## πŸ“ License

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

(back to top)