The Really Useful Logging and Event Repository Project - https://ruler-project.github.io/ruler-project/
Before you begin, ensure you have the following prerequisites installed:
- Python3
- pip
-
Clone the repository to your local machine:
git clone https://github.com/Ruler-Project/ruler-project.git
-
Create a Python virtual environment.
python3 -m venv ruler-project-web
-
Activate the virtual environment:
On Windows:
ruler-project-web\Scripts\activate
On macOS and Linux:
source ruler-project-web/bin/activate
-
While in the virtual environment, install the project dependencies using pip:
pip3 install -r requirements.txt
-
Make sure you're in the virtual environment with the project dependencies installed.
-
Run the MkDocs development server:
mkdocs serve
-
Access the website locally by opening a web browser and navigating to http://localhost:8000.
The pages are stored in docs\RULER\<folder name>\<file>.md and then need to be referenced within the mkdocs.yml file.
We welcome contributions to improve The RULER Project. To contribute please fork the "Develop" branch of the repository and then create a pull request with any changes.
Upon review, the changes will be merged into the project. We will then do a pull request to "Main" which should automatically build the gh pages (If the action works...testing in progress...)
Thank you for contributing to The RULER Project!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent