Conviction Vacation Initiative

Table of Contents

• Conviction Vacation Initiative
  • Table of Contents
  • About The Project
  • Development Setup
    • Installation
    • Other Commands
  • Development Process
  • Sanity
  • Tools / Services
  • License

About The Project

Formerly Clearviction, we are a civic-tech open source project.

One in four Washingtonians have been involved in the criminal justice system. Those with a criminal record in Washington face significant barriers to daily life after completing their prison terms, making it harder to find housing and employment, to gain professional credentials, and to be involved in the life of their community. Washington State’s New Hope Act makes it easier for people with past criminal records to have their convictions vacated. Even then, the process of vacating a conviction is very convoluted, making it difficult for most people to navigate.

Development Setup

To get our static website up and running on your machine, you can follow the commands below:

git clone https://github.com/clearviction-devs/clearviction-wa.git

Installation

In the project directory, you can run:

1. Ensure you have nodejs installed on your machine using whatever system package manager, on Mac using homebrew run:

   brew install nodejs

2. Install project dependecies

   npm install

3. Start the app in development mode

   npm run dev

4. Visit http://localhost:3000 to view it in the browser

Other Commands

 npm run build

The underlying command, next build generates an optimized version of your application for production. The output is generated inside the .next folder.

Development Process

1. Create a .env file using .env.local.example as a guide.
2. Create your feature branch git checkout -b feature/your-feature-name
3. Commit your changes git commit -m "commit message describing your changes"
4. Push your changes to your feature branch git push origin feature/your-feature-name
5. Create a Pull Request in GitHub against the staging branch
6. Once all changes in staging are verified, staging is merged into main by every 2 weeks via cron job (main should only ever be merged to from staging)

Sanity

We are using Sanity as our CMS. You can find the Sanity repository here.

Make sure you read the dev guide on how to use Sanity here. Changes involving calculator pages, and possibly other content may need to be made in the Sanity repository as well as Sanity Studio.

Tools / Services

• NextJS - React-based Web Framework
• MUI - UI / Component Library
• Sanity - Content Management System / Content API

License

Distributed under the MIT License. See LICENSE for more information.