Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 3.86 KB

README.md

File metadata and controls

97 lines (78 loc) · 3.86 KB
Raw

Website Screenshot

logo

AlphaByte Official Website

Official website of AlphaByte, Amity University Mumbai.

Table of Contents

‒ Hosting
‒ Tech Stack
‒ Dev Environment Setup
‒ Project Structure
‒ Edit Data
‒ Contributing
‒ Discord
‒ License

🚀 Hosting

Project is currently hosted on Netlify.

Live URL: https://alphabyte.info

⚙️ Tech Stack

  • HTML, CSS, JavaScript
  • Gulp - a task runner to automate the development workflow.
  • Sass - a CSS preprocessor that gives CSS many superpowers.

🔨 Dev Environment Setup

Let's get the website up the running on your local machine.

0. Prerequisites

1. Fork repo

Fork this repo to your GitHub account

2. Clone repo

Clone the forked repo to your local machine

git clone https://github.com/<YOUR-GITHUB-USERNAME>/alphabyte-website.git

Navigate to project directory

cd alphabyte-website

3. Install Dependencies

npm install

4. Start Dev Server

npm run start

A browser window will automatically open up with a live-reloading preview of the code.

🗃 Project Structure

  • src/ folder contains all the source files.
  • dist/ folder contains generated build files which are to be deployed.
  • src/pages/ folder contains html files corresponding to the pages available on the website.
  • src/sections/ folder contains reusable html files that can be included inside pages. (nav, footer, etc.)
  • src/css/ folder contains page specific css files
  • src/css/all/ folder contains css files that are included in every html page on the website.
  • src/js/ folder contains page specific javascript files
  • src/js/all/ folder contains javascript files that are included in every html page on the website.
  • src/images/ folder contains all images on the website.
  • src/data/ folder contains data files for events and members.
  • src/copy/ folder contains files to be directly copied to root of website (dist/). Contains favicons.
  • gulpfile.js is the Gulp config file, in-charge of launching dev server, bulding project, minifying JS and CSS, compressing images, etc.
  • babel.config.json is the Babel config file. Babel allows us to use the latest JavaScript features that might not currently be supported in all browsers.

💾 Edit Data

All changing data is saved in separate javascript files as an object so that its easy to modify.

  • Events data: Modify src/data/data_events.js file
  • Members data: Modify src/data/data_members.js file

💻 Contributing

  • Make sure you have correctly setup your environment by following the steps in Environment Setup.
  • To work on an feature/issue, make sure to leave a comment under that issue or open a new issue if not already opened. This will make sure that multiple people are not working on the same issue.

💬 Discord

Connect with us on Discord.

📜 Licence

This software is open source, licensed under the MIT License.