Giter Site home page Giter Site logo

stuff's Introduction

HoagieStuff

Everything on campus, from bulletin to sales, in one place.

Setup

NOTE: You will need a .env.local file from a Hoagie Project coordinator to run most of the features. Place it in your main directory. You will also need Node.js, NPM, and Yarn, there are plenty of tutorials online on how to install these. Assuming you have those tools and files, do the following to install dependencies:

yarn

and finally, run the server with:

yarn dev

As simple as that! We use yarn for everything related to dependencies so do NOT use npm install when you are trying to add new packages. Instead use yarn add.

VSCode

We use VSCode for development. Please install the following packages:

  1. ESLint
  2. Live Share

ESLint is particularly important, if everything is installed correctly, it will allow you to see style errors inside the editor which we use to make sure our code is tidy and consistent throughout the codebase (same as output from yarn lint).

Contribution

Follow this guide to setup a fork of this repository along with the upstream. Always create new branches when adding new features. For example, let's say I am adding a delete button. I would do:

# Switch to new branch called delete-button
git checkout -b delete-button

When the main branch get updated, you want to run the following:

# Fetch upstream master and merge with your repo's main branch
git fetch upstream
git checkout main
git merge upstream/main

# If there were any new commits, rebase your development branch, for example delete-button
git checkout delete-button
git rebase main

You may have to deal with merge conflicts; this will be visible and easier to deal with in VSCode. Here's a short video about how to do it.

stuff's People

Contributors

ananyagrover1 avatar djapp18 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.