Skip to content

🌐 Hub for Embark's open source efforts

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

sandagomipieris/opensource-website

Β 
Β 

🌐 opensource-website

Netlify Status Contributor Covenant Embark

Hub for Embark's open source efforts.

About

This is a static site made using Vue.js.

Project data is provided by a small JSON file, but in the future this should be grabbed from an API.

All non-project data and text is hardcoded for now, but in the future this should be provided by a CMS.

We should also add routing, multiple pages, and all sorts of other things πŸ™‚

User Guide

Running the site locally

The site is all front-end code and doesn't require a built tool or compile step. There is however a development server you can use if you don't have one you would prefer to use.

# Install the deps
npm install

# Run the development server
npm start

Adding or Changing Projects

The site's data comes from data.json. You can add a new project by adding its info to this file.

{
  // Make sure the name is exactly the same as the GitHub repo name
  "name": "texture-synthesis",
  // The most important part
  "emoji": "🎨",
  // Add tags that you find relevant, as a comma-separated array
  "tags": ["rust"],
  // Short description to display on the card
  "description": "Example-based texture synthesis written in Rust",
  
  // The following fields are only required if the project will be featured:
  "featured": true,
  // Longer description, displayed on the featured card
  "extendedDescription": "A light Rust API for Multiresolution Stochastic Texture Synthesis, a non-parametric example-based algorithm for image generation.",
  // URL to an image to display on the featured card
  "featureImage": "https://camo.githubusercontent.com/c279dea27db2c10f64cd27563d8d7cc86048c5c1/68747470733a2f2f692e696d6775722e636f6d2f43735a6f5350532e6a7067",

  // Lastly, if this property is included the project will be hidden 
  // from the website.
  "hidden": "This project is being soft-launched, so don't show it on the website"
}

Adding or Changing Category Sections

You can insert a section showing all projects with a specified tag by putting the following into index.html:

<!-- Replace "rust" with your tag -->
<project-category
  tag="rust"
  v-bind:projects="projectsWithTag('rust')"
></project-category>

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

🌐 Hub for Embark's open source efforts

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 57.4%
  • CSS 26.0%
  • JavaScript 16.2%
  • HCL 0.4%