Nueno - Open Source ATS (Applicant Tracking System)

Project setup

Database

1. Duplicate env.example and .env.test.example and rename to .env and .env.test
2. run docker-compose up -d

You haven't installed docker and docker-compose on your system?

Here's an installation guide

You'll only need these commands when using docker-compose:

# start running containers
docker-compose up -d

# shut-down running containers
docker-compose down

# list running containers
docker-compose ps

Code Climate (for code quality check)

Create a free code climate account and add the CODE_CLIMATE_TEST_REPORTER_ID to your github repo settings.

Screenshot

Development workflow

Default setup:

1. npm run dev
2. open localhost:3000

Test Driven Development:

Recommended workflow when writing code for ./business-logic.

1. npm run test
2. in chrome open: chrome://inspect and click on the remote target URL. This will open a console with your test process.
3. add debugger statement in your code
4. tests will be re-run once you save a file

Run tests

npm run test

Optionally, you can add a name pattern of the file name:

npm run test User

Check test coverage:

1. npm run test:coverage
2. open file ./coverage/lcov-report/index.html