Giter Club home page Giter Club logo

state-talentmap's Introduction

United States Department of State TalentMAP

Build Status Test Coverage Code Climate Dependency Status

A comprehensive research, bidding, and matching system to match Foreign Service employees with the right skills to available posts and positions.

Getting Started

Dependencies

We use yarn as our package manager, available for download here. Where possible, we've included the corresponding commands for npm.

Install dependencies with yarn install or npm i

EditorConfig

We use EditorConfig to ensure consistency across file formats and code editing environments. EditorConfig supports a variety of popular code editors listed here.

Running the App

TalentMAP API

You will need the State TalentMAP API running locally in order for this application to make requests to the API.

React Application

yarn start or npm start

Runs the app in development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will see the build errors and lint warnings in the console.

Build errors

yarn test or npm test

Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.

Read more about testing.

yarn build or npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. By default, it also includes a service worker so that your app loads from local cache on future visits.

Your app is ready to be deployed.

See the create-react-app documentation for more details.

Docker

The front end application is Dockerized and available in a docker-compose stack with the API. Setup and more available here.

Deploying

There is a brief deployment guide here that discusses deployment up the front end application. For more thorough intructions, including the API, checkout out the wiki.

Accessibility

Accessibility tests can be run in a CI environment using pa11y-ci. By default, it tests the URL array found in .pa11yci using the WCAG 2.0 AA standard. Be sure to update the array of URLs with IDs that exist in your environment's database.

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

state-talentmap's People

Contributors

mjoyce91 avatar burgwyn avatar chiu-kevin-bah avatar jseppi avatar wongperson avatar jesse-russell avatar bradnunnally avatar amirbey avatar imgbotapp avatar dependabot[bot] avatar kakumanipk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.