Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.02 KB

README.md

File metadata and controls

71 lines (44 loc) · 2.02 KB
Raw

Civic Tech Toolkit

For Civic Tech projects—right now it’s hard to start and harder to stay! CivicTech should be easier, and it should be fun!

When people show up to do good, let's make their odds great by being better together. Read more on wiki:Vision.

Essentials

Current Focus:

  • We are creating a civic tech project guide to help people interested in creating civic tech projects.

Get involved:

  1. Join the CivicTechTO Slack and our #civic-tech-toolkit channel.
  2. Attend a weekly hacknight at CivicTechTO and join our group.
  3. Contribution Guide on the wiki Coming Soon

🚀 Development - Getting Started

To run this project locally and start contributing, follow these steps:

Prerequisites

  • Node.js (LTS version recommended)
  • npm (comes with Node.js)

Installation

  1. Clone the Repository

    git clone https://github.com/CivicTechTO/civicsaurus.git
cd civicsaurus

  2. Install Dependencies

    npm install

Running the Development Server

   npm start

This will start the local development server. The site will reload automatically if you make changes to the code.

Building the Site

To create a production build of your site:

   npm run build

The build output will be generated in the build directory. You can serve this directory locally to test the production build:

   npm run serve

Contributors

List Coming Soon -- w/ allcontributors.org

Colophon

  • Docusaurus: This website is built using Docusaurus, a modern static website generator.
  • GitHub Pages & Actions: This website is hosted using GitHub Pages with GitHub Actions deployment automations.