A Library of all the components for MSK Documents

Open terminal in the project root directory.

run npm i;

run npm start;

The app will start on http://localhost:6501/

If you want an invitation to the slack channel where all the fun is happening, send an email to [email protected]

I am Manoj Satish Kumar | Founder of MSK Documents.

I would like to thank you for volunteering to contribute as an Open Source Developer to this project. I appreciate your interest in learning web development and supporting the Mission.

I also want to express my gratitude for considering this as an opportunity. I promise it will be an interesting journey. Let us all learn from each other during the process because the greatest strength of software developers is the community.

Please make sure you respect other developers in the group. Learning is a 2-way process. Review other's code and provide review comments on the pull requests. If you find issues / bugs, log it here.

That being said, I will be onboarding you to this project.

All the best !

If you are reading this, you are Awesome !

MSK components is an open-source project for developing UI components for MSK Documents.

Using MSK Documents, a user will be able to build and share all kinds of mobile responsive professional documents like resumes, cover letters, job descriptions, certificates, appreciation letters, job postings, webinar invitations, and much more...

As an open-source developer, you will be contributing to this project by creating different kinds of component variants. These variants will then go through an approval process and finally Go LIVE on MSK Documents.

Please carefully read the Mission statement.

This is a learning platform. You get to work with 400+ web developers online who are contributing to this project and upskill yourself in web app development.

• Your profile will be featured in the contributors page when you contribute.
• You get to work on a highly scalable UI project and can add it to your resume projects section.
• Students can update their LinkedIn profile with the title Open Source Developer at MSK Documents.
• When your component goes LIVE, the whole world gets to know your work and use what you have created to build their documents online. You will impact the lives of many job seekers.
• Most importantly, you will enjoy the journey and will have a story to tell to your juniors.

If you are a student or an entry level developer and want to get started with the contribution, you will need to learn few concepts first before starting your contribution to this project.

If you are already an experience developer, you can directly goto Step 5.

• Read basics of HTML, CSS and Javascript
• Read basics of JSX and JSS
• A brief introduction to React
• Commonly used npm commands

Once you are comfortable with the above basic concepts, you need to learn to use the below tools

• Install Git ( learn forking, cloning, commiting and raising pull requests )
• Install VS Code and get familiar with the code editor

Now you are ready to start coding.

Once you fork, git will create a copy of msk-components to your personal github space.

Once you clone, you will have the project in your computer. Go ahead and open the project in VS Code.

Set the original repository as the upstream remote.

run git remote add upstream https://github.com/ManojSatishkumar/msk-components.git

So, whenever other developers merge their code, the master branch of the original repository gets updated. You can get the latest code into the master branch of your fork with the below command.

run git checkout master

run git pull upstream master

Now you can create a separate branch and start working.

Node is required to run this project as this is a react app.

run npm install in the project root directory. This will install all the node_modules required.

run npm start. This will open the application on http://localhost:6501/

There is a folder called sample inside the resume module. Go ahead and check all the files inside. There is a detailed documentation at the beginning of each file. This should give you enough explanation about the file and certain rules and best practices to be followed.

Once you are familiar with the sample component, go ahead and add your own components and variants. Research online and identify different components inside vaarious documents.

After finishing your code, you are ready to contribute. Go ahead and make a commit and push the changes to your fork branch. Then submit a pull request to msk-components/master.

• Add atleast 5 reviewers in the PR
• Always submit a PR from a named branch from your fork
• Attach Desktop & Mobile screenshots to the PR
• Choose the label in the PR ( bug / enhancement / maintenance etc., )
• Add a proper title & description

Assign few contributors as reviewers and get your code reviewed. You will need approvals from 3 other contributors for your pull request to get merged.

Check the issues section where you will find new ideas / challenges / bugs. You can pick one by adding a comment to the thread that you will be working on it. ( This will avoid duplicate work )

Please close the issue when your corresponding pull request gets merged.

I wish you all the best in this journey.

Let's create an incredible product !

THANK YOU