manishram / assessment

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Conduit

This repository contains a full-stack TypeScript application consisting of a NestJS backend and an Angular frontend.

Prerequisites:

  • Docker or a locally running MySQL installation
  • NodeJS 16+ (tested with v18.13.0)
  • Code Editor (VSCode is recommended)

Getting started:

  • Install the dependencies npx yarn install.
  • If you don't have a local MySQL installation, start one in docker: docker run -d -p 3306:3306 --name mysql -e MYSQL_ROOT_PASSWORD=conduit -e MYSQL_DATABASE=conduit -e MYSQL_USER=conduit -e MYSQL_PASSWORD=conduit mysql:8.1
  • Adjust the apps/backend/mikro-orm.config.ts with your MySQL credentials (they already match the ones from the docker command above).
  • Start the app (both backend and frontend at once): npm start.
  • After the backend successfully starts, in a new terminal npm run seed to seed the database with some initial data.
  • You can now access the UI at http://localhost:4200 and login with jcosten0@purevolume.com / password.
  • You can also find the backend API spec at http://localhost:3000/docs.

About

License:MIT License


Languages

Language:TypeScript 89.5%Language:HTML 7.7%Language:JavaScript 2.4%Language:Shell 0.2%Language:CSS 0.1%Language:Dockerfile 0.1%Language:SCSS 0.0%