/cea.ac.in

Website for College of Engineering Adoor

Primary LanguageHTMLMIT LicenseMIT

Website for College of Engineering Adoor

https://ceadoor.github.io/cea.ac.in/

License Node.js npm Build Status

Welcome! This repository houses all of the assets required to build the website for College of Engineering Adoor. We're very pleased that you want to contribute!

To get started

You must have Node.js LTS installed in your machine to use Webpack

Quick Start

1. Fork this repository

2. Clone the fork to your local machine

git clone https://github.com/username/cea.ac.in .

3. Switch to the directory and Install All Packages

npm install

4. Start Development Environment

npm start

Check the browser at http://localhost:8080/ to see the live local version

How to use

  • Add your html files in the src directory (By default index.html is added to your src directory, feel free to edit it)

    • Make sure you add it in your webpack.config.js (Replace yourfile with your filename)

      plugins: [
          ...
          new HtmlWebpackPlugin({
              template: 'src/yourfile.html',
              inject: 'body',
              filename: 'yourfile.html'
          }),
          ...
      ],
  • Add images to your src/assets folder

  • Add sass files to src/scss folder

    • Make sure you import the scss file in main.scss

      @import "filename";

N.B.

After modifying 'webpack.config.js' file, make sure you install the currently required modules with

npm install

Then start development environment normally with

npm start

Ideas?

Go through the milestones first.

Found something new to add?

Create a regular issue here