Skip to content

CanopusFalling/Queer-Calendar-Sheffield

Repository files navigation

How to Contribute

  • Submit issues if you want to see a feature or find a bug here!
  • Fork this repo and submit a pull request if you want to contribute to the website.
  • If you would like to get involved with the calendar get in touch!

Development Setup

Requirements

  • Node Package Manager v9.8.1
  • NodeJS v18.15.0

Version numbers are based on what has been tested, newer versions will likely work.

Install instructions for node and npm.

Local Evnironment Setup

  • Create a copy of .env.local.sample and name it .env.local.
  • Replace [Google-Calendar-API-Key] with your google API key. The API key must have the calendar API enabled. Instructions to obtain a Google API key.

Installing Node Modules

Run the following to install all node modules.

npm install

Running the Project

Run the following command to launch the project.

npm run dev

You should then be able to view the local website on http://localhost:3000.

Testing

Run npm run test:cypress to test the project using the cypress interactive UI.

npm run test:cypress-headless runs all tests in a terminal.

About

Repository for the code that runs the Queer Calendar Sheffield sharable calendar.

Resources

License

Stars

Watchers

Forks

Packages

No packages published