From 938cb1495cdfe7f8a9b430a8747644e88bb0dacc Mon Sep 17 00:00:00 2001 From: Saloni Vaishnav Date: Tue, 20 Aug 2024 13:36:11 -0500 Subject: [PATCH] update README.md --- README.md | 34 +++++++++++++--------------------- 1 file changed, 13 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 1fb42dac..3446ea4d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,24 @@ IllinoisWCS.github.io ===================== -# About +## About -This is the main website for Women in Computer Science at UIUC. -Current owners are Neha Vardhaman (@neha-vard) and Anushri Mittal (@Anushri-Mittal). +This is the main website for Women in Computer Science at UIUC. It is deployed at https://illinoiswcs.org and https://wcs.illinois.edu +Current owners are Saloni Vaishnav (@inolasv) and Firmiana Wang (@firmianaw). -# Making Edits +## Local Development -Set up a simple http server to view edits you make locally. [This guide](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server) should help with that. Refresh the localhost tab to view changes after saving them in your code editor. +To install and set up locally, first run `npm i` and then `npm run dev`. The application will run on http://localhost:3000 -# Pull Requests +## Technologies + +This application is built with Next.js + + +## Pull Requests Please never commit to master, even if you have permission. -Run all changes by the Head of Infrastructure. Here are the steps to making a change and solving an issue: +Run all changes by the Infrastructure Chairs. Here are the steps to making a change and solving an issue: 1) Make a branch off ```master```. Please give it a descriptive message. @@ -23,17 +28,4 @@ Run all changes by the Head of Infrastructure. Here are the steps to making a ch 4) Once you're ready, create a pull request with base as the ```master```. -5) Write a descriptive title and comment. You can reference the associated issue with a #. - -# Style Guide -* You can do tabs or spaces, but please set your tab to 4 spaces. - -* Use camelCase, not snake_case. - -* Put braces on the right. - -* Lines should not be longer than 80 characters. - -* Put a comment above each function describing what it does. - -* Alphabetize your CSS. +5) Write a descriptive title and comment. You can reference the associated issue with a #. \ No newline at end of file