Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 2.44 KB

README.md

File metadata and controls

63 lines (49 loc) · 2.44 KB

UF OSC WEBSITE

GitHub issues GitHub Actions Workflow Status GitHub package.json version GitHub

Website for the UF Open Source Club. Started in the Fall semester 2022, this website is built and maintained by club members to serve as a hub of information for the club.

Install

Clone the repository (requires git):

git clone https://github.com/ufosc/Club_Website_2.git

Navigate to the project directory and install the project dependencies (requires Node.js):

cd Club_Website_2
npm install

Usage

Starting the development server:

npm run develop

You may access the website at http://localhost:8000

Building for production:

npm run build

The gatsby webpack analyzer will briefly spawn a page at 127.0.0.1:3001 with the JavaScript bundling information before exiting. Once the build is finished, the website can be served with gatsby:

npm run serve

The website may be accessed at http://localhost:9000

Maintainers

Maintained by the UF Open Source Club, can be contacted via Discord

Current Maintainers:

Documentation

Documentation is available online at docs.ufosc.org. Please see the osc-docs project if you're interested in helping with documentation.

Contributing

All contributions are welcome and appreciated, we're always looking for new ideas or improvements. If you're interested in helping, please see the GitHub issues page for tasks that need help. Alternatively, you may propose new ideas by opening new issues. Contributors should read the contribution guidelines.

License

AGPL-3.0-or-later
Copyright (C) 2024 Open Source Club