https://github.com/perfringis/nexai-recruitment-task
nexai-recruitment-task
https://github.com/perfringis/nexai-recruitment-task
Last synced: 3 months ago
JSON representation
nexai-recruitment-task
- Host: GitHub
- URL: https://github.com/perfringis/nexai-recruitment-task
- Owner: perfringis
- Created: 2024-12-27T11:17:08.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T14:10:52.000Z (5 months ago)
- Last Synced: 2025-01-12T15:24:53.666Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 466 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nexai-recruitment-task
# dev-and-deliver-recruitment-task
## Table of contents
- [Setup locally](#setup-locally)
- [Docker setup](#docker-setup)
- [Swagger documentation](#swagger-documentation)
- [Tests](#backend-tests)
## Setup locally
1. Clone repository:
```sh
git clone [email protected]:perfringis/nexai-recruitment-task.git
```
2. Go to a project and install packages.
```sh
pnpm install
```
3. Configure .env file based on .env.dev template.
```sh
DATABASE_NAME=
DATABASE_PORT=
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_HOST=
```
> NOTE! You can omit `DATABASE_HOST` or setup as `127.0.0.1`.
4. Run project in `dev` mode. List of all commands you will find in the `package.json` file.
```sh
pnpm run start:dev
```
## Docker setup
1. Clone repository:
```sh
git clone [email protected]:perfringis/nexai-recruitment-task.git
```
2. Run docker configuration:
```sh
docker compose -f docker-compose.yml --env-file backend/.env up
```
OR
```sh
./docker-up.sh
```
## Swagger documentation
Documentation is available under `localhost:3000/api`.
## Backend tests
Run backend tests by:
```sh
pnpm test
```