A joint project between Code for America and The County of Santa Barbara Public Defender's Office
Jeanmarie Levy, Design (jlevy@codeforamerica.org)
Victor Sauceda, Engineering (vsauceda@codeforamerica.org)
Timothy Malstead, Engineering (tmalstead@codeforamerica.org)
This is a React and Next.js project bootstrapped with create-next-app and modified to use TypeScript
In addition, Docker is used in production deployment and to host the dev database locally.
To install, open your cli and run:
git clone https://github.com/sbpublicdefendersoffice/sb_reentry_app.git
Naviagate to your created directory and install the needed dependencies by running:
yarn
Then, run the development server:
yarn dev
Open http://localhost:3000 with your browser to see the app running.
The app will auto-update as you edit components and pages.
We recommend that you install Docker Desktop to aid you in using data for local development.
After installing, run:
yarn build_data
from the root directory of the project.
This will create an instance of a PostgreSQL database and seed it with information to get you up and running quickly.
If Docker is not a viable option for your use case, you can install the dev data locally.
Make sure you have the Chocolatey package manager installed. I recommend installing Git Bash as it will install Choclatey and you will be able to take advantage of the *NIX like syntax.
Once installed, open shell using admin rights and enter the following command
choco install postgresql13 --params '/Password:admin’
It should install fairly quickly. Approve whatever security allowances it asks for.
Once that is done, close out of your shell session and enter into a new one without admin rights and enter:
postgres --version
to ensure the installation was successful.
Now, navigate to the root directory of the project and enter:
PGPASSWORD=admin psql -U postgres -f ./data/native_pg_init.sql
This will create the user you need to access the data in a dev environment and give them the correct permissions.
After that, enter:
PGPASSWORD=admin psql -U postgres -d thrive -f ./data/native_pg_seed.sql
to seed the database.
Congrats! You should now have a working database for the app on your Windows machine
We kindly ask that if you are working on a feature, you checkout to a branch named with the following convention
your_github_username/feature_name
once you have completed work on your feature, please push your work using:
git push origin feature_name
and make a pull request.
Please feel free to submit any information you feel is relevant along with your PR. If we do not currently have you on our list of contributors, please reach out so that we can add you.
To initiate a production build, run:
yarn build
To serve the build run:
yarn start
and you will see your build being served in a production environment on http://localhost:3000.
We are using ESLint, stylelint and Prettier as well as the TypeScript compiler to ensure consistent and readable code in our project.
Please refer to the top level **rc.json files to view specific rules and configurations.
If you feel you need to change or update any of the settings to accommodate work on your feature, please include a brief description of how and why in your PR.
To type-check .ts and .tsx files, please run:
yarn type-check
To check .js, .jsx, .ts and .tsx files, run:
yarn lint-es
To check .css and .module.css files, run:
yarn lint-css
To format all files with Prettier, run:
yarn format
Each command will show a message printed on the console if it was executed sucessfully.
We make use of Jest, Testing_Library and Next_Page_Tester to ensure reliability of our components, pages and APIs.
To start the test suites, run:
yarn test
To run ALL code testing, linting and formatting, run:
yarn code-check
We are using husky and lint-staged to code check staged files in git.
These hooks include all testing, linting and formatting procedures.
Please note, Next Page Tester can take a bit to run full page rendering tests. Be patient! It'll get there.
The check will run automatically when you add a local commit, and there is no need to configure them.
If there are errors in your staged code, please fix or comment them out and then run the checks again.
If there is something that you feel you must commit that is not passing the code formatting standards, you can commit using a --no-verify flag. Please keep this to a minimum and only use it when absolutely necessary. Linting, testing and formatting tools can be annoying, but in the end they are helping us write a better application. We appreciate your help!
In dev mode, by default, we run source maps in eval-source-map mode. This is a good mix of performance and thoroughness.
Should you need to examine even more exhaustive source maps in a production build, please enter:
yarn build_with_source_maps
This will create a production build with full source-map level source maps.
Please note that this is a resource intensive information, thus we have increased the memory available to node to 4 gigabytes. That will likely be all that's necessary, but please feel free to adjust should your system need more.
When building a local production build, we have a webpack bundle visualizer to help you better understand the final bundle output.
After a production build has finished, enter:
yarn analyze
to view the visualization.
All jsx components must be written in PascalCase as they will be interpreted as standard DOM tags if they are not begun with a capital letter.
In addition we ask that you write interface, type and CSS module class names in PascalCase as well.
In the case of CSS modules, we write them this way instead of the normal kabob-case because Type/JavaScript will not understand expressions with a - in them.
For the rest of the Type/JavaScript code, please use the standard camelCase naming convention.
Lastly, please title environmental variables or references to them in SCREAMING_SNAKE_CASE.
All of this will help the readability of the code by showing a clear demarcation between standard code and functions, React and TypeScript specific code and functions and other special types of code.