gama-platform.github.io - sources branch

On this branch, you have all the sources from the website gama-platform.github.io which is the documentation of the Gama-Platform.

Editing Website

If you want to read how to modify the content of the website, please go in the website/ subfolder.

If you want to edit the blog, you can click here and if you want to read the blog documentation click there !

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need to have NodeJS, npm and a terminal to run shell and PHP scripts installed on your machine.

Also, I recommand to use git to download projects, but you can deal without it.

Installing

View contents

Here's a step by step series of command that tell you how to get a development env running.

First of all, you need to download this project on the sources branch

git clone https://github.com/gama-platform/gama-platform.github.io.git -b sources

Now, move on the project and clone the Gama wiki in the folder. This project is not inside by default because I want it updated at each build (in Travis) and I wanted to keep this repo lightweight.

cd ./gama-platform.github.io
git clone https://github.com/gama-platform/gama.wiki.git

Now, you'll run some custom scripts which will pre-process every files for the website.

The first script will copy every files from gama.wiki/ to the right location in the new website.

sh ./script/unstructurize.sh

The second script will correct some links (to images or else) in markdowns files.

sh ./script/link_fixer.sh

This two lines will generate a sidebar Docusaurus-friendly (a JSON) from the gama.wiki's one.

sed -i '/^$/d' './docs/_Sidebar.md' # Remove blank line
php script/sidebarCopy.php

The last script will create a header (learn more here) to have correct title in pages.

sh script/autoHeader.sh

The final command to prepare the project is to install npm packages. So you should move in the website/ sub-folder and install packages listed in packages.json file.

cd <project>/website
npm install

Now you have your project ready to start it in your local machine! Congrats.

All you need to do is to start your project with npm from the website/ folder

cd <project>/website
npm start

In less than a minute, you should have the website running in local on port 3000 open in your favorite browser.

Deployment

All the deployment (pulling last wiki, running every previous scripts, building React project and publish new version) is done by Travis CI. The whole process is written in the <project>/.travis.yml file.

Travis CI will regenerate automatically the website every 24 hours or at every commit on the sources branch.

Built With

• React - A NodeJS library for building user interfaces
• Docusaurus 2.0.0-beta-20 - The React framework used
• Algolia DocSearch - Search engine (Open-Source Program)
• GAMA Wiki - Sources for the whole wiki part of the website

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Arthur Brugiere - Restarted work since 1.8 - RoiArthurB

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL3 License - see the LICENSE.md file for details.