https://github.com/fluid-project/fluidproject.org

The Fluid Project website
https://github.com/fluid-project/fluidproject.org

Last synced: 3 months ago
JSON representation

The Fluid Project website

• Host: GitHub
• URL: https://github.com/fluid-project/fluidproject.org
• Owner: fluid-project
• Created: 2011-10-18T19:42:49.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T18:21:51.000Z (6 months ago)
• Last Synced: 2024-06-21T13:33:00.098Z (5 months ago)
• Language: HTML
• Homepage: http://fluidproject.org
• Size: 5.73 MB
• Stars: 13
• Watchers: 13
• Forks: 32
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

• awesome-starred - fluid-project/fluidproject.org - The Fluid Project website (others)

README

        
# Fluid Project Website

[![Netlify Status](https://api.netlify.com/api/v1/badges/c85cc19e-8bf7-4c7d-a6cb-f00dcd2da954/deploy-status)](https://app.netlify.com/sites/fluid-fluidproject-org/deploys)

This repository contains the files needed to build a copy of the Fluid Project website,

it is not an immediately deployable version of the website.

[11ty](http://11ty.dev/) is used to build the site from source files.

## To Build Locally

1. Get the required node modules: `npm install`

2. Run [11ty](http://11ty.dev) from the fluid-website directory `npm run start`.

3. Open `http://localhost:8080/` to see the website.

## To build locally using Docker

You can serve the website from a [Docker](https://docs.docker.com/get-docker) container.

Once you have Docker installed, run the following commands to build a Docker image and start

a container:

* Build the image: `docker build -t fluidproject .`

* Run the container: `docker run --name fluidproject -p 8000:80 fluidproject`

The website will be available at [http://localhost:8000](http://localhost:8000)

If you make changes to the website, repeat the steps to build the image and start a new container.

## To deploy to a personal webserver

1. Run: `npm run build`

2. Copy the contents of `./_site/` directory to your server.

## Notes

* Modifications can be done to any source file or directory except for the contents of the `_site` directory.

* The `_site` directory is not versioned since it contains the generated output made by 11ty from the source files,

  and the files in `_site` are overwritten at build time.

* The changed source files in _site directory gets overwritten at build time.

## License

The Fluid Project website is available under [Creative Commons Attribution License](http://creativecommons.org/licenses/by/4.0/).