Skip to content
Snippets Groups Projects
Commit 6dc21b0b authored by Madeleine Stenberg Jonassen's avatar Madeleine Stenberg Jonassen
Browse files

Update file README.md

parent ffecbac4
No related branches found
No related tags found
No related merge requests found
Pipeline #270166 passed
# BrainStormer
## Description
### Description
BrainStormer is a full-stack web application developed for the IDATT2105 course. It provides a comprehensive and user-friendly platform for creating, managing, and taking quizzes for educational, training, or entertainment purposes. Inspired by popular quiz platforms like Quizlet, Kahoot, and Quizizz, BrainStormer aims to offer a similar experience with its own set of unique features.
## Features
......@@ -17,11 +17,69 @@ BrainStormer is a full-stack web application developed for the IDATT2105 course.
- Feedback and Support
## Installation
1. Clone the repository: git clone https://gitlab.stud.idi.ntnu.no/madelesj/fullstack.git
2. Navigate to the project directory: cd brainstormer
3. Install dependencies: npm install
4. Start the frontend server: npm run serve
5. Navigate to http://localhost:5173/ in your web browser.
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
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with Vitest
```sh
npm run test:unit
```
### Run End-to-End Tests with Cypress
```sh
npm run test:e2e:dev
```
This runs the end-to-end tests against the Vite development server.
It is much faster than the production build.
But it's still recommended to test the production build with test:e2e before deploying (e.g. in CI environments):
```sh
npm run build
npm run test:e2e
```
### Lint with ESLint
```sh
npm run lint
```
### Database Login
To log in to the database server, use the following credentials:
- IP: 129.241.98.27
- Username: student
- Password: R8W9b7D52pw
## Usage
1. Register or login to your account.
......@@ -34,7 +92,7 @@ For help or assistance, please open an issue on the GitHub repository or contact
## Roadmap
* Implement AI-based generation of questions.
* Enhance collaboration features such as commenting and revision history.
* Implement collaboration features.
* Improve accessibility and mobile responsiveness.
## Contributing
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment