The source repository for The Collab Lab website.
This website requires Node and NPM to be installed in order to run locally. You can view the NPM documentation to learn more about installation.
You may also need the Netlify CLI to test certain features such as the Stripe donation buttons. If you need access to Netlify, you can request access in #committee-website and someone will invite you to the Netlify project.
Clone the website using Github CLI.
gh repo clone the-collab-lab/website
Run npm i
in the repository directory to install all the necessary packages and to set up Husky for pre-commit linting.
Use this link to access the playground and schema for our GraphQL endpoint.
Depending on your IDE, you may have the ability to introspect the schema and unlock type checking in your editor:
graphql.config.json
and copy/paste the json found below..graphqlconfig
file and copy/paste the json found below.schema.graphql
file from the config.The JSON config for either VS Code's or IntelliJ's config file is:
{
"name": "Collab Lab GraphQL Schema",
"schemaPath": "schema.graphql",
"extensions": {
"endpoints": {
"Default GraphQL Endpoint": {
"url": "https://api-us-east-1.graphcms.com/v2/ckfwosu634r7l01xpco7z3hvq/master",
"headers": {
"user-agent": "JS GraphQL"
},
"introspect": true
}
}
}
}
For other platforms, consult the documentation for your IDE.
pages/graphql
.src/_data
directory is used to create variables and pass data to the *.liquid
files.src/assets
is where all of our JavaScript, stylesheets, image assets, fonts, and other asset files can be found.src/_includes
hosts the main layout file (defined in src/pages.11tydata.json
) along with any additional reusable templates.src/*.11tydata.js
files are used to create variables and pass data to the src/*.html
files, which generate the different pages on the site.To run the site:
npm run dev # starts the dev server on port 8080
To build the site:
npm run build # builds the site and outputs it in the /build/ folder
To build and run the build version of the site:
npm run build:serve # builds and serves the site in localhost:5000
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request, or create a new issue!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)main
branch of this repo as the base.