Welcome to the repo for oxyos.org, the website for Oxy Open Source!
Components you will need to download/install
- Download Node from nodejs.org, and install
- In the terminal, run the following command:
sudo npm install -g
- Install nodemon:
sudo npm install -g nodemon
- All of the other dependencies are listed in
package.json. All you need to do is, after cloning the repo to your machine, navigate to the project root and run:
Run each of these commands in separate terminal windows:
npm run react-dev
npm run server-dev
http://localhost:8080/ in your browser. Hopefully this worked! If not, Google and other project members are your friends.
Setting up a React app can be tricky. Here are some errors that we've encountered and how to fix them:
"Nodemon is not recognized as an internal or external command, operable program or batch file."
npm install --save nodemon in your terminal.
"Module not found: Error: Can't resolve 'url-loader'"
npm install url-loader --save-dev in your terminal.
Adapted from this Medium post
- On Github, fork oxy-os/oxyos.org
- Either using GitKraken (highly recommended), any other git GUI, or the command line, clone the repo
- In the Remote section of the left panel in GitKraken, click the "+" button and add oxy-os as a remote
- Open the repo on your local machine, and checkout the
- Make your changes,
- Go to your forked copy of the repo on Github, and open a pull request from your development branch to oxy-os/development
Keeping your fork up to date with oxy-os
- In GitKraken, on the left panel, click and drag oxy-os/development on to Local/development
- Click "Merge oxy-os/development into development"
- Now you have all of the new changes that have been accepted into oxy-os/oxyos.org on your local development branch. To see those changes in your forked repo on Github, simply