diff --git a/README.md b/README.md index 37451abe9568da2570fd768090ab8a4430549b50..f758401d869fcf342efd6fd31f07cad8c32b773c 100644 --- a/README.md +++ b/README.md @@ -16,38 +16,19 @@ BrainStormer is a full-stack web application developed for the IDATT2105 course. - Progress Tracking - Feedback and Support -## Installation -Clone the repository: git clone https://gitlab.stud.idi.ntnu.no/madelesj/fullstack.git - -This template should help get you started developing with Vue 3 in Vite. - -### Recommended IDE Setup - -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). - -### Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -### Project Setup - +## Running the application +To run the back-end, run FullstackApplication.java (FullstackProsjekt/src/backend/main/java/edu/ntnu/idatt2105/FullstackProsjektApplication.java). +To run the front-end, move to FullstackProsjekt/src/frontend and run the following commands: ```sh npm install ``` - -### Compile and Hot-Reload for Development - -```sh -npm run dev -``` - -### Compile and Minify for Production - +then ```sh npm run build ``` + ### Run Unit Tests with Vitest ```sh npm run test:unit