CSATimes Web

Table of Contents

• Quick Start 💥
• Features 🧾
• Browser Support 🌐
• Installation 🐣
• Starting the app
• Contribution Guidelines ✒

Quick Start

This is the github repository for CSA Times Web Portal, an all encompassing comprehensive Web portal for students of BITS Pilani, Goa Campus.

1. Clone the repo
2. Install modules - yarn install
3. Deploy - yarn serve

Features

Login/Logout Dashboard - Campus Updates

Student Portal - Details about Clubs/ Departments/ Important Campus Websites

Browser Support

Edge	Firefox	Chrome	Safari	Opera
Edge	last 3 versions	last 3 versions	last 3 versions	last 3 versions

Installation

Follow these steps to install this project directory:

# clone the repo
$ git clone https://github.com/plutoniumm/csatimes.git

# go into app's directory:
$ cd myproject

# install dependencies
$ yarn install

Starting the app

Follow these steps to run the app on your local machine:

# go into app's directory:
$ cd myproject

# Deploy
$ yarn serve

Contribution Guidelines

1. Fork the repo on GitHub.
2. Push your work back up to your fork.
3. Submit a pull request.

Pull Request Guidelines

1. The subject should be a short one line summary of the change you've made.
2. The extended description should include a deatiled description of the changes you've made and also a list of all the files you've made changes in.
3. One pull request should cater to only one change. *A change may include multiple file changes that are essential to solving the issue/change.

Developers - Manav Sekseria (@plutoniumm), Aviral Kumar Goel (@Aviral09)