Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.54 KB

README.md

File metadata and controls

56 lines (35 loc) · 2.54 KB
Raw

Project ThunderCAT

This application is a collaboration between Code for Canada and the Public Service Commission of Canada.

This project serves as an example of a deployment front-end (ReactJS) and back-end (Django with PostgreSQL DB) using docker and nginx.

Quick start

  1. Follow our setup guide to configure your workstation.
  2. Clone the repository using git
  3. docker-compose up to build the application if you have not done so already
  4. Open your browser to http://localhost:80/.

To see a list of all build commands, run docker from the repository root or see our notes-on-docker.

How to help

Interested in what we're working? Learn more about us and our project. Want to contribute? Please email caley@codefor.ca.

What's in this repo?

Here's a quick overview of the major landmarks:

backend

The server for our CAT platform, a Django application responsible for:

  • not much yet, but it will hold our APIs

frontend

The ReactJS application that users will see. It uses the Airbnb Styleguide. It will get built into a static package that we serve through nginx once we deploy it. We are using a combination of React-Bootstrap, Aurora Design System, and custom PSC-specific for our components.

This includes:

  • home page
  • status page
  • any prototypes we're working on

Documentation

  • SETUP: Instructions to get everything up and running.
  • TESTING: How to be sure nothing broke.
  • TODO: add license
  • There are many more topical guides in the docs folder.
  • In addition, several sections of the repository have their own documentation:

Snyk Vulnerabilities

frontend/package.json -> Known Vulnerabilities

backend/requirements.txt -> Known Vulnerabilities