![Analysis](https://github.com/bcgov/nr-results-exam/actions/workflows/analysis.yml/badge.svg)
Natural Resources RESULTS Exam Web Application
This repository holds a set of policies, standard, guides and pipelines to get
started with a React TS Web Application.
Our Policy
- Work in the open: That means that everything we do should be open, should be
public. Please, don't create private repositories unless you have a very strong
reason. Keeping things public is a must follow rule for BC Government.
- Customer centred services: All the work that's been created is to improve
users, customers, and friends usability and experience. Is important to keep
that in mind, because as engineers sometimes we face technical issues, however, our goal is to have a good product.
- Community based work: Remember that you're not alone. It's very likely that
your problem is someone else's problem. Let's figure it out together. So, ask
a question using our channels. We have our own Stackoverflow
and our Rocket Chat channel.
Stack
Here you will find a comprehensive list of all the languages and tools that are
been used in this app. And also everything you need to get started, build,
test and deploy.
- React Progressive Web Application
- TypeScript
- Context API
- React Testing Library
- Jest
- Lint
- Tools
- Docker
- Microsoft Visual Studio Code
- Styling
- Carbon Design System
- Bootstrap
- Authentication
Getting started
Once you have cloned this repository, you can get the app running by typing
npm install
and then npm run start
from the project root directory. Then
head to http://localhost:3000.
Be aware of the required environment variables:
- REACT_APP_MAIN_VERSION
- REACT_APP_COGNITO_REGION
- REACT_APP_USER_POOLS_ID
- REACT_APP_USER_POOLS_WEB_CLIENT_ID
- REACT_APP_AWS_DOMAIN
To run the unit tests all you need is npm run test
.
Before writing your first line of code, please take a moment and check out
our CONTRIBUTING guide.
Getting help
As mentioned, we're here to help. Feel free to start a conversation
on Rocket chat, you can search for @jazz.grewal
.