From fb144c710e0f004d570a98830998ef7c13c80a52 Mon Sep 17 00:00:00 2001 From: DanYu12 Date: Thu, 28 Sep 2023 18:08:57 -0400 Subject: [PATCH] readme --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6463b2b..157f515 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ -# React + Vite +# BostonHacks Registration Portal 2023 -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +[![Actions Status](https://github.com/bostonhacks/bostonhacks-2022/workflows/Production%20Workflow/badge.svg)](https://github.com/Bostonhacks/BostonHacks-2022/actions) +[![License](http://img.shields.io/badge/License-MIT-brightgreen.svg)](./LICENSE) -Currently, two official plugins are available: +## Project setup -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh -# Bostonhacks-2023 +```bash +npm install +npm run dev +``` + +The dev server should open on [http://127.0.0.1:5173/](http://127.0.0.1:5173/). + +## Github Workflows + +Github workflows is set up on this project so that there is an automatic deployment to the [BostonHacks staging site](staging.bostonhacks.io) so changes can be seen on the site after each merge. + +## Deploying the Website to Production + +After running the buildscript, run the following command. + +```bash +firebase deploy --only hosting:production +``` + +Open [https://bostonhacks.io](https://bostonhacks.io/) to view production