Skip to content

Latest commit

 

History

History
89 lines (49 loc) · 2.57 KB

README_sample.md

File metadata and controls

89 lines (49 loc) · 2.57 KB
Raw

app_name

Build Status Coverage Status

Replace this description for your new application... lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas eget pulvinar est.

System Requirements

  • Python (3+)
  • Docker
  • Node

Development Stack

  • Django (4.2)
  • Vue (3.2)
  • Vite (2.9)
  • Vitest (0.10.2)

Design Stack

  • Bootstrap (5.2)
  • Bootstrap Icons (1.9.0)

Installation

Clone the repository

    $ git clone [email protected]:uw-it-aca/app_name.git

Go to your working directory

    $ cd app_name

Copy the sample .env file so that your environment can be run.

    $ cp .env.sample .env

Update any .env variables for local development purposes

Development (using Docker)

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/

Testing

Front-end Testing (using Vitest)

Run Vitest test scripts and generate coverage report

    $ npm run test
    $ npm run coverage

Linting (using ESLint and Stylelint)

Run ESLint for JS linting

    $ npm run eslint

Run Stylelint for CSS linting

     $ npm run stylelint

Python Testing (using Django)

Run unittest

    $ docker-compose run --rm app bin/python manage.py test

Authors

Academic Experience Design & Delivery

License

Copyright 2022 UW Information Technology, University of Washington

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.