[ ] Complete hiring process through Workday and Onboard@Penn (if applicable)
Set up tools
We use the following tools in our development workflow to help us collaborate effectively. Even if you have your own preferred tools, such as a git client or IDE (🤓), please make sure to set up and become familiar with the tools that we use as a team. This will allow you to assist others if they encounter problems with these tools.
[x] If you're working on a Mac and using iCloud to back up your files, you may find that GitHub version control and iCloud's version control don't play well together. I would recommend creating a folder that isn't backed up to iCloud (for example at ~/github/) for storing all your repositories.
[x] Create a branch of the deliberation-empirica repo, called something like james-first-test (but use your own name 🤔). When you make changes to the code, you'll make them in a branch, and submit a pull request to incorporate your changes into the main branch.
Running the code
[x] In the deliberation-empirica directory, run npm run build to install the project dependencies.
[ ] After building, run npm run start to start empirica
Test
Everything we do, we test!
End to end tests
[x] In the deliberation-empirica/cypress directory, run npm install to install the cypress testing dependencies.
[ ] In the deliberation-empirica directory, use the command npm run test to launch cypress.
Unit tests
We have some unit tests on the server code for functions that run in the background
Welcome to the team! This template will walk you through everything you need to do to get started contributing to the deliberation project.
Admin
Set up tools
We use the following tools in our development workflow to help us collaborate effectively. Even if you have your own preferred tools, such as a git client or IDE (🤓), please make sure to set up and become familiar with the tools that we use as a team. This will allow you to assist others if they encounter problems with these tools.
Get the code
[x] If you're working on a Mac and using iCloud to back up your files, you may find that GitHub version control and iCloud's version control don't play well together. I would recommend creating a folder that isn't backed up to iCloud (for example at
~/github/
) for storing all your repositories.[x] In this directory, use GH desktop to clone the following repository: https://github.com/Watts-Lab/deliberation-empirica.
[x] Create a branch of the deliberation-empirica repo, called something like
james-first-test
(but use your own name 🤔). When you make changes to the code, you'll make them in a branch, and submit a pull request to incorporate your changes into themain
branch.Running the code
deliberation-empirica
directory, runnpm run build
to install the project dependencies.npm run start
to start empiricaTest
Everything we do, we test!
End to end tests
deliberation-empirica/cypress
directory, runnpm install
to install the cypress testing dependencies.deliberation-empirica
directory, use the commandnpm run test
to launch cypress.Unit tests
We have some unit tests on the server code for functions that run in the background
server
foldernpm run test
to start the unit test suiteResources
The following describe the deliberation project:
Below are a set of resources for helping you complete the above tasks.