Skip to content

Latest commit

 

History

History
98 lines (77 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

98 lines (77 loc) · 3.63 KB

Contributing to JobIE

👋 Hope you enjoy contributing to JobIE 👍

The following is a set of guidelines to help you begin your contribution to the JobIE. If you want to propose any change to this document feel free to propose changes to this document in a pull request.

How to Contribute

Raise an Issue

Did you find something which can be improved further ?? Feel free to share it here.

Pull requests are the way concrete changes are made to the code, documentation dependencies, and tools contained in the JobIE repository.

Setting up your local environment

Step 1:Fork

Fork the project on Github and clone your fork locally to your system.

Using SSH:

    $  git clone [email protected]:<your_username>/jobie.git

OR

Using HTTPS:

    $ git clone https://github.com/<your_username>/jobie.git

Then navigate to JobIE

    $ cd jobie

Step 2:Branch

To keep your development environment organized, create local branches to hold your work. These should be branched directly off of the main branch. 
   $ git checkout -b my-branch -t upstream/main
   $ git remote add upstream https://github.com/akshatnema/jobie.git
   $ git fetch upstream

Step 3:Build

Now we are ready to build the project , but first of all make sure that you have NodeJS installed in your system.

Inside the jobie folder run the following commands to install all the dependencies.

    $ cd server
    $ npm install

(To install all the server side dependencies)

Similarly for the front-end side, use the following commands in the jobie folder

    $ cd web
    $ npm install

Step 4:Setting up development variables

Now we need to create a .env file which will contain our development variables such as Atlas string(URI) and Twitter Bearer Token for the twitter API. 
    $ cd server
    $ touch .env
    $ nano .env

Note:You can use any text editor in place of nano.

Now inside the .env file use your development variables as shown below.

    ATLAS_URI="mongodb+srv://user_name:[email protected]/?retryWrites=true&w=majority"
    TWITTER_API="AAAAAAAAAAAAAAAAAAAAANAUSgEAAAAA%2BwvPQqv%xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxdCH93sdrzv"

Twitter Bearer Token: Click here.

ATLAS URI: Click here.

Step 5:Start Developing

For all the users working on the frontend. You can make changes and load JobiE locally by running the following inside the web directory.

   $ npm start

Similarly for the server side, use the same command inside the sever directory.

Your site will be hosted locally at: http://localhost:3000/

Step 6:Commit

It is recommended to keep your changes grouped logically within individual commits. Commits are a great way to help your fellow contributors keep check of the changes you made to the project.

   $ git add my/changed/file
   $ git commit -m "changes-made"

Push

Once your commits are ready to go begin the process of opening a pull request by pushing your working branch to your fork on GitHub.

   $ git push origin my-branch

🎉Enjoy!! Your work is done. Go and upload your amazing PR now..👍