Welcome to the repo for oxyos.github.io, the website for Oxy Open Source!

Git workflow

Requirements

1. The python programming language, which can be downloaded from python.org
2. The python packages Flask and Frozen_Flask
   1. These can be installed by running python3 -m pip install -r requirements.txt within the same folder that the code is in

Once you have all the requirements, continue to Environment Setup

Environment Setup

1. On Github, fork oxyos/oxyos.github.io
2. Either using GitKraken (highly recommended), any other git GUI, or the command line, clone the repo
   1. For GitKraken: In the Remote section of the left panel in GitKraken, click the "+" button and add the forked repo as a remote

Once you have the files, continue to Running the Site for Development

Running the Site For Development

1. To develop, run the following command to start the built-in flask web server:
   1. MacOS/Linux/Windows: python3 main.py
2. This will start the server on port 5000 on your machine, open any browser (Chrome, Firefox, Safari, etc...) and navigate to localhost:5000

Once you have finished building the site, continue to Making Contributions

Making Contributions

1. commit and push the changes to your forked repo's master branch
2. Go to your forked copy of the repo on Github, and open a pull request from your master branch to oxyos/oxyos.github.io/master

You are now done! Enjoy your updates to the site

Keeping your Project Up-to-date With The Website

1. Run git pull to get all the changes