Skip to content

docs: added scripts section for contributors #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: added scripts section for contributors #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,20 @@ Welcome to the frontend repository of the Sundarbans House IITM's web applicatio
- [Reporting Issues](#reporting-issues)
- [License](#license)


## Getting Started

### Step 1: Sign In

Sign in with your official student gmail account ending with 'iitm.ac.in'.

### Step 2: Explore Your Group

Click on your profile name to find your group number, along with the group leaders' contact information and the WhatsApp group invite link for your group.

![Sundarbans House](https://github.com/SundarbansWebOps/Frontend/blob/main/src/assets/docs/image2.png)

### Step 3: Explore

Relax and explore other sections!

## Usage
Expand All @@ -37,8 +39,39 @@ Relax and explore other sections!

The Current TechStack is:

[![Stack](https://skillicons.dev/icons?i=vue,js,tailwind,django)](https://skillicons.dev)
[![Stack - VueJS, Javascript, TailwindCSS, Django](https://skillicons.dev/icons?i=vue,js,tailwind,django)](https://skillicons.dev)

## 🛠️ Setup

### 1. Install Dependencies

Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
Then, install the project dependencies:

```bash
npm install
```

### 2. Available Scripts

The following npm scripts are available:

| Command | Description |
| --------------- | ------------------------------------------------ |
| `npm run serve` | Compiles and hot-reloads the app for development |
| `npm run build` | Compiles and minifies the app for production |
| `npm run test` | Runs unit tests |
| `npm run lint` | Lints and fixes files |

### 3. Run the Development Server

Start the local development server:

```bash
npm run serve
```

By default, the app will be available at [http://localhost:8080](http://localhost:8080)

You can contribute to this project by:

Expand All @@ -60,6 +93,6 @@ You can report any issues that you find within the app by 'Creating a New Issue'

This is an open-source project licensed under the [GPL-3.0 license](https://github.com//blob/main/LICENSE).

## Don't Forget to Star ⭐ the Repository!
## Don't Forget to Star ⭐ the Repository!

And feel free to contribute and make our web application even more amazing!!!