Website for softwarecrafters.org
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
communities
conferences
docs
scripts
src
target
test
.babelrc
.gitignore
.nvmrc
.travis.yml
LICENSE
README.md
communities_schema.json
conferences_schema.json
logo_sticker.png
netlify.toml
package-lock.json
package.json
rollup.config.js

README.md

Favicon Software Craft Website

Build Status Deps DevDeps

The website powering softwarecrafters.org, a website for people to find their local Software Craft communities.

Feel free to fork this repository and add your local community to it.

⚙️ Setup

The website uses rollup to bundle the client-side JS and some hand-written preprocessing in order to merge and lint the communities/*.json files. The app is integrated via Travis and deployed to netlify.com.

It is helpful to use nvm in order to make sure you're using the particular node version we are using.

nvm install           # installs the node version we are using
npm install -g yarn   # Install yarn
yarn                  # Install dependencies

yarn build            # Build initial version
yarn watch            # Run the watch task
yarn test             # Validate the present schemata

🌐 Adding your community / conference

If you want to add your local community / conference to the map, please have a look at how the other communities added their community (resp. conferences). There is a JSON schema your community.json is validated against through Travis (resp. for conferences).

  1. Fork this repository
  2. Create a new file in communities/${YOURCITYNAME}.json (resp. conferences/${YOURCONFERENCE}.json)
  3. Enter valid JSON as of the schema (resp. conferences_schema.json)
  4. Commit & push your change
  5. Create a Pull Request against this repository

Finding the coordinates of your city...

...can be very tricky, which is why we're logging the current position of your mouse every time you click somewhere on the map.

GIF showing how a mouse click logs the coordinates under the map to the console

👍 Contributing to the website

TBD

💻 3rd-party libraries used

To be documented. For the moment, have a look at our target/vendor/ directory and our package.json.

  • materialize-css
  • rollup
  • babel
  • font-awesome
  • mapbox
  • jquery

The logo is a remix of 🌐 from emojiOne released under Creative Commons Attribution 4.0 International and the Softwerkskammer Logo released under Creative Commons Attribution 3.0.