mkeleti/acm-site

Website for ACM@KU

ACM@KU Website
Explore the docs »

Report a Bug · Request a Feature . Ask a Question

---

About

This website serves as the homepage for the University of Kansas ACM.

Built With

• Astro
• Tailwindcss
• Svelte

Getting Started

Prerequisites

• Vscode - (optional) There are workspace settings and extensions preloaded to make development easier.
• Node & NPM
• Yarn

Installation

1. git clone https://github.com/mkeleti/acm-site
2. cd acm-site
3. yarn install

Usage

• yarn dev - Run Dev Server on localhost

• yarn build - Build HTML files

• yarn check - Checks Astro files

• yarn preview - Starts local file server

• yarn format - Formats files with prettier

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub issues
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of ACM@KU Website:

• Add a GitHub Star to the project.
• Tweet about the ACM@KU Website.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make ACM@KU Website better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Michael Keleti.

For a full list of all authors and contributors, see the contributors page.

License

This project is licensed under the MIT license.

See LICENSE for more information.