Codebase of https://agendaopensource.github.io

Add a new event or meetup

Open an event issue, or if you feel adventurous:

• Edit the file _data/events.json
• Add a new object to the file keeping exactly the same structure:

{
    "@context": "http://schema.org",
    "@type": "Event",
    "location":{
        "@type": "Place",
        "name": "[LOCATION NAME]",
        "address": "[ADDRESS]",
        "district": "[DISTRICT]"
    },
    "name": "[NAME]",
    "startDate": "[START DATE]",
    "endDate": "[END DATE]",
    "description": "[DESCRIPTION]",
    "url": "[URL]"
}

How to contribute

Feel free to contribute by suggesting new events or by fixing any open issues.
Don't forget to follow our code of condutct!

• Fork the project
• Create a descriptively named feature branch
• Add your feature
• Submit a pull request

If a PR contains a change to a JSON file (as e.g. in _data/ folder) please make sure that they are validated properly. There are online linters to help you, for instance:

• https://jsonlint.com
• https://www.jsonschemavalidator.net

Run this project locally

Assuming that you already have node and yarn already installed:

$ git clone https://xxx.git
$ cd jam-react/
$ yarn install 
$ yarn start

Then open http://localhost:3000/

Environment variables

Environment variables that are needed for development are specified in .env.dist

- SITE_URL: http://localhost:8080/
- SITE_ANALYTICS - Analytics

Dependencies

• react-static to generate static pages and routing
• eslint (airbnb) - to assert that good practices are followed properly
• material-ui for presentation
• dotenv to facilitate configuration using environment variables (as suggested in 12factor)
• moment to work with dates easily

ToDo:

[] Add helmet for SEO stuff
[] Move all custom CSS values into theme.js
[] Review all styles (use theme constants!)
[] Documentation
[] Move site urls e constants to getSiteData() and consume using withSiteData
[] Test everything!
[] PWA/AMP

Documentation

• Airbnb lint
• Material UI
• react-static
• .env support (12factor - III)