Giter Club home page Giter Club logo

protege's Introduction

Getting started

Here at Protegé, we use create-react-app on the front-end, Tailwind CSS for styling, and Google Firebase for the back-end. Getting a local environment set up is fairly simple.

  1. Pull down the repo
  2. Run npm i to install peer deps (if you're using VScode then it may be beneficial to add the eslint and prettier extensions)
  3. Contact Drew to get dev env variables

And you're good to go!

Submitting a PR

Before we get too far, we'd like to say thank you for considering contributing to Protegé.dev!

We use Atlassian's Git Workflow model for version control on Protegé.

What that means is that we have a Main branch, a Develop branch, and then feature/feature-name or hotfix/hotfix-name branches for development of the platform.

To keep in line with this workflow, your process for submitting a PR should follow the steps below.

  1. Fork the repo to your local dev environment

  2. Create a new branch under the feature/ flag

  3. Name the branch in a concise way that eludes to what it does (ex: feature/add-active-nav-state)

  4. Create your PR into the Develop branch

  5. Leave a short message in the PR explaining in slightly more detail what the PR accomplishes.

  6. If your PR touches multiple parts, consider adding a bullet list of accomplishments, example below

    * adds new component x for data handling
    * updates component y to use component x
    * refactors component y for code reusability
    

protege's People

Contributors

albertopdrf avatar andregamma avatar ashikpaul42 avatar bekahhw avatar clandau avatar danieltott avatar drewclem avatar forresthayes avatar imgbotapp avatar jhuynh85 avatar jleikam avatar kldickenson avatar laurentcodes avatar marierere avatar muchirijane avatar mwlai288 avatar nelson-chinedu avatar nickytonline avatar ottogutierrez avatar pickleat avatar seanmcp avatar seanwash avatar surajrpanchal avatar

Watchers

 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.