ojosproject.org: Home to Ojos Project, Iris, Palliaview, and more

Table of Contents

• ojosproject.org: Home to Ojos Project, Iris, Palliaview, and more
  • Table of Contents
  • Description
  • Features
  • Getting Started
  • Installing dependencies
  • npm commands
  • Contributing
  • Branching
  • License

Description

Welcome to the repository for ojosproject.org, Ojos Project's home on the Internet! This contains the source code for our website.

Our website is built using Docusaurus, the documentation website builder.

Features

Thanks to Docusaurus, we use three of its features on our website:

• Blogging, which is displayed on the /news/ path
• Documentation, which is displayed on the /docs/ path
• Any other pages we'd want to create using React

Getting Started

[!IMPORTANT] Please make sure to follow the Ojos Project git policies

Installing dependencies

If you'd like to make changes to the website, you can! First, you'll have to install the dependencies with npm:

npm i

npm commands

There's four useful commands Docusaurus provides:

[!TIP] If you're having issues with Docusaurus, clearing the cache with npm run clear may help.

Before pushing, I recommend running npm run clear; npm run build; npm run serve, which runs the three commands in that order to make sure you don't have any remaining bugs.

Contributing

You can contribute by opening an Issue (after, of course, checking if the same issue doesn't already exist) or providing code.

Branching

Please don't use the main branch. It must always be stable and will only be merged into.

If you're a member of the Ojos Project GitHub organization, please commit quick changes to dev. Otherwise, create a branch with any name. Then open a Pull Request pointing to dev.

If you're not a member, please create a fork copy of dev, commit your changes, and open a Pull Request pointing to dev.

License

Content: Creative Commons Attribution 4.0 International

Code: GNU General Public License v3.0