Skip to content

Latest commit

 

History

History
51 lines (46 loc) · 1.93 KB

README.md

File metadata and controls

51 lines (46 loc) · 1.93 KB

UF OSC Website

standard-readme compliant GitHub issues GitHub JavaScript Style Guide GitHub Workflow Status
Website for the UF Open Source Club.

Install

This project requires NodeJS and Git. Also, make sure you have build-essential (Linux) or xcode-select (MacOS).

sudo apt install build-essential
// or...
xcode-select --install

Next, begin by cloning the repository:

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

Navigate to the project directory and install the project dependencies:

cd Club_Website_2
npm install

Usage

Starting the webserver:

npm start

You can access the website by visiting http://localhost:3000 on your browser.

Linting & fixing:
This project adheres to the Javascript Standard syntax style, running the following will show you a list of syntax errors that you'll need to correct.

npm run lint

To automatically fix these, you can run:

npm run fix

Keep in mind that some syntax issues cannot be automatically resolved, in which case you'll need to run npm run lint again and resolve them manually.

Running tests:

npm run test

Contributing

All contributions are welcome and appreciated, so long as they adhere to the license. Contributors are urged to familiarize themselves with the contribution guidelines.

License

AGPL-3.0-or-later
Copyright (C) 2007 Free Software Foundation, Inc.