Skip to content

Latest commit

 

History

History
148 lines (101 loc) · 5.41 KB

README.md

File metadata and controls

148 lines (101 loc) · 5.41 KB

BrumAI logo

BrumAI Website

A sleek, intuitive, and powerful front-end framework for Birmingham's premiere AI events organisation.

Explore BrumAI docs »

View the website

Branches A2, B, C

Our default branches for development are Branch A2, Branch B and Branch C, allowing for the distribution of labour in a team.

Table of contents

Quick start

Status

NPM MUI Netlify Git Github Pages CSS3 TailwindCSS React Next JS JavaScript HTML5 Instagram LinkedIn YouTube Twitter Supabase

Documentation

BrumAI's documentation, are publicly hosted on GitHub Pages. The docs may also be run locally. The BrumAI website, is hosted on Netlify.

Our documentation search is powered by Algolia's DocSearch.

Running_Documentation_Locally

  1. Run npm install to install the Node.js dependencies, including Hugo (the site builder).
  2. Run npm run dev to run the development server for the project.
  3. Open http://localhost:3000/ in your browser, and voilà.

Making_Ammendments

Please see the data file located at 'app/data/data.js' to make ammendments to the dats in the project. We have structured the project in a way to ensure the centralisation of data here to allow for the project to be as maintainable as possible.

Community

Creators

David Mason

Cal Woodford

Taimoor Balal

Samantha German

Alexander Brown

Katarzyna Baginska

Sponsors

Buy_Us_A_Coffee