Bob's BrainBox

Contents

• Bob's BrainBox
  • Contents
  • About Bob's BrainBox
  • Built with
  • How to run
  • How to contribute

About Bob's BrainBox

This repository contains the frontend website of the Bob's Brainbox application, the backend/server repository is contained within this repository.

The project is part of the final project in the Boolean fullstack development course. The goal behind Bob's Brainbox is to develop a fullstack application in 5 days, to then be presented to other groups in the course. It will first be made into a very simple, bare-bones, MVP application, then further developed as time permits.

Built with

How to run

This is a node project, as such it is very easy to both install and run the website locally.

First install required dependencies

npm install

then initalize the project

npm run dev

Starting the application is development mode will make it available through a localhost address, since the project uses Vite the default port is 5173. Navigate your browser of choice and enter the url

http://localhost:5173

If other Vite projects are currently running, it will increment the port to run on, in that case look at your terminal window and find the port it is attached to.

How to contribute

This is a closed project, only preapproved people will be allowed to contribute

To ensure uniform standard in branches, commits, and pull requests we have several guidelines on how to contribute to the project. These guidelines are contained within documentation/how_to_contribute.

Back to top!