README.md

Resistance Calendar

PRs welcome; seeking all roles

See our contributing guide for more information.

The Resistance Calendar aims to empower progressive activists by providing a massive central listing of upcoming events. Crowdsourced event submissions are curated by a team of volunteers, while events from allied organizations will be included automatically. Event filters make it easy for people to find events near them. Filtered notifications help people discover new events immediately.

This is a rebuild of the live website currently found here.

Table of Contents

• About the Resistance Calendar
• Contributing Guide
• About the stack
• Getting Started
  • Setup
  • Install
  • Test
  • Lint
  • Run
• Build
• Project hierarchy
  • Features
  • CSS
• Project License

About the stack

This repository covers the ReactJS front-end. The API can be found here.

Getting Started

Setup

• Fork the repository
• Clone the project: git clone [email protected]:ResistanceCalendar/resistance-calendar-frontend.git
• Change into the directory: cd resistance-calendar-frontend

Install the dependencies

yarn

Note: Can also use npm instead of yarn for these commands. Here's an article comparing the two package managers.

Run the test suite

Uses Jest/Enzyme

yarn run test

yarn run test:watch

Run the linter

Uses Airbnb's eslint rules with some modifications

yarn run lint

yarn run lint:watch

yarn run lint:watch-npm

Run the dev server

yarn run dev

This project will run on http://localhost:5050/

Build the project

yarn run build

Project hierarchy

Features

• Webpack v2
• Babel to compile ES2016+

CSS

Component-level styling uses Sass, SCSS, or CSS with CSS Modules. Global styles are placed in src/style's subdirectories, and component-level styles are placed in the component's folder.

Note: the CSS Module property camelCase is enabled, meaning styling classes defined as, say, .test-name will be referenced inside of a component file as stylesObj.testName. This allows us to follow CSS naming conventions while avoiding bracket notation in Javascript.

Project License

MIT

---

Return to top