ALiAS Website Source

The ALiAS website is undergoing a rewrite using shadcn/ui. Meanwhile, this website serves as a temporary solution to maintain asetalias.in.

Project Overview

Within this project, you'll find the following folders and files:

.
├── public
│   ├── assets
│   │   └── images
│   │       └── alumni
│   │       └── communities
│   │       └── members
│   │       └── posters
│   │   └── ...
│   └── data
│       ├── about.json
│       ├── alumni.json
│       ├── events.json
│       ├── volunteers.json
│       └── socials.json

1. about.json contains data related to the about section, like why and what ALiAS is and how ALiAS reaches its goals.

2. alumni.json stores:

   • PFP (Profile Picture) image path, which is stored in assets/images/alumni.
   • First name and last name of alumni.
   • Latest designation(s) of alumni.
   • Social links, namely Linkedin and Github.

3. communities.json stores:

   • name of the community
   • path of the community logo which is stored in assets/images/communities
   • community webpage link
   • outline(boolean): whether to outline the logo

4. events.json stores:

   • Poster image path, which is stored in assets/images/events.
   • Title, date, time, and venue of the event.
   • Description: a short description of the event.

5. volunteers.json stores:

   • PFP (Profile Picture) image path, which is stored in assets/images/volunteers.
   • Name of the volunteer.
   • Role of the volunteer: Faculty coordinator, Volunteer, Supporter (volunteers who are not from Amity University).
   • Social links, namely Linkedin and Github.

Contribution and Local Development

To contribute to this project or run it locally, follow these instructions:

Installation

Important

This project uses bun for package management and runtime. So please install it from here.

1. Fork this repository.

2. Clone your fork and navigate to the project's root directory.

   git clone https://github.com/<your_github_username>/asetalias.github.io.git
   cd asetalias.github.io

3. Install necessary dependencies:

   bun install

Local Development

1. After installing the dependencies, start the local development server by running:

   bun dev

   This will launch the server, and you can access the site at localhost:5173 in your browser.

2. Make your desired changes to the project files.

3. Check for formatting errors.

   bun check

4. Format the codebase

   bun format

Tip

Formatting is automatically done through git hooks (husky, lint-staged).

Questions or Discussions

Join our Discord server for any questions, discussions, or further assistance.

Credits

This is based on the lovely ALiAS Lucknow.