Welcome to form-app 👋

An application to onboard employees at Los Angeles County Public Defender.

Prerequisites

• prettier used for formatting. You can use the Vscode extension.
• node
• npm
• angular cli for more information

Installation

Before you get started with the installation, make sure you have node and npm install. You can verify by running npm --version and node --version. It is preferable if you use node 12.17 and npm 6.14.

1. First you have to clone the repository. You can do this by running git clone https://github.com/PDSeniorDesign/form-app.git. Please note that this url can change.
2. Then cd into the directory that was just created and run npm install. This will take care of installing all the dependencies that are needed.
3. Once the dependencies are installed, you can run ng serve and the application should start running. You can also run npm run start.

Usage

ng serve

Run tests

ng test

Development

Folder Structure

• core contains core functionality such as services, models, etc.
  • models
  • services
  • types
• form contains the logic for the forms. Employee form and Contractor form are included here.
  • contractor-form where all the logic for the contractor form will live.
  • employee-form where all the logic for the employee form will live.
• homepage contains the logic and markup for the homepage.
• request-status a page to view the status on a specific form
• shared includes components that can be used throughout the app.

Committing/Pushing

If you would like to contribute, please follow the following guidelines:

Work on new branch

Before you start coding, make sure you are not working on the master branch. Create a separate branch by using the command git checkout -b <NAME OF BRANCH>. For example, if I was going to make a commit to fix a typo, I would use git checkout -b fix-typo.

Branch naming conventions

That brings us to another point, if you are implementing something new make sure the branch starts with the prefix feature-. If you are implementing a fix, make sure the branch starts with the prefix fix-. This is just to keep things organized and well-named.

Formatting

Before commiting please format your code with prettier. This is a tool that formats the code for you. Since this is what is currently being used, this is the recommended formmater. If you use Visual Studio Code, there is a plugin for the formatter that you can install. There are some shortcuts you can use.

Test Server

When a pull request or commit gets pushed to the master branch, it will automatically trigger the test server to update. The test server is here. It should mirror what is on the master branch.

2021 Authors

👤 Adrian Palomares

• Github: @adrianpalomares

👤 Tabassuma Torosa

• Github: @rtiare

👤 Paul Clef Ube

• Github: @PaulClefUbeCoding

2021 Authors

👤 Ryan Lee

• Github: @Ryanseanlee

👤 Joshua Parez

• Github:

This README was generated with ❤️ by readme-md-generator