An application for managing student advising information.
- Python (3.10+)
- Docker
- Node
- Django (4.2)
- Vue (3.2)
- Vite (2.9)
- Vitest (0.10.2)
- Bootstrap (5.2)
- Bootstrap Icons (1.9.0)
Clone the repository
$ git clone git@github.com:uw-it-aca/compass.git
Go to your working directory
$ cd compass
Copy the sample .env file so that your environment can be run.
$ cp .env.sample .env
Update any .env variables for local development purposes
Docker/Docker Compose is used to containerize your local build environment and deploy it to an 'app' container which is exposed to your localhost so you can view your application. Docker Compose creates a 'devtools' container - which is used for local development. Changes made locally are automatically syncd to the 'app' container.
$ docker-compose up --build
View your application using your specified port number in the .env file
Demo: http://localhost:8000/
Run Vitest test scripts and generate coverage report
$ npm run test
$ npm run coverage
Run ESLint for JS linting
$ npm run eslint
Run Stylelint for CSS linting
$ npm run stylelint