bossy-helper

Web based application to guide students in open source development

MIT License

Stars
7

BOSSY HELPER

Introduction

You are the BOSS of your life. Help yourself and your friends to give their open source journey a head start by contributing to this web based application. Come learn with me to lead life instead of living it.

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

Usage

To run the project first install all dependencies by running npm install.

Now, in the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

JS and SCSS quality assurance

Before submitting a PR/MR make sure your code is compliant with our JS rules by running npm run test:js. You can format it automatically by running npm run format.

To make sure your SCSS is compliant run npm run test:scss.

Build it to ensure it will work on production

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.The build is minified and the filenames include the hashes. Your app is ready to be deployed! See the section about deployment for more information.

Badges
Extracted from project README
GitHub license GitHub stars GitHub forks GitHub top language