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.
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
Important
Please make sure to follow the
Ojos Project git policies
If you'd like to make changes to the website, you can! First, you must install nvm (or a similar tool). Then run:
nvm use
npm iThere's four useful commands Docusaurus provides:
| Command | Description |
|---|---|
npm run start |
Starts the website in development mode |
npm run clear |
Is something not working? This clears the cache! |
npm run build |
Makes a production-ready version of the website |
npm run serve |
Starts the website in production mode |
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.
You can contribute by opening an Issue (after, of course, checking if the same issue doesn't already exist) or providing code.
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.
Carlos Valdez is the maintainer of the website repository. The website is being developed by the Ojos Project team at the University of California, Irvine.