Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

68 lines (36 loc) · 1.66 KB

🚀 How to contribute ?

  1. Fork this repository on GitHub.

  2. Clone the forked repository in your computer.

    $ git clone https://github.com/<your-username>/Narrow-Links.git

    $ cd Narrow-Links

🛠️ Installation and Usage

  1. Go the folder where you want to contribute:

    $ cd client OR cd server

  2. Run the development server:

➡️ To run the client , open your terminal and :

$ cd client

$ npm install

$ npm run start

➡️ For running server open your terminal and ( You can skip this step if you are contributing to the frontend only ) :

-> Configure your environment variables

  • Create a file named .env then enter the following data inside it

    TWILIO_ACC_SID = "Get your twilio account SID from your console"
TWILIO_AUTHTOKEN = "Get your twilio Auth-Token from your console"
TWILIO_NUMBER = "Get your twilio Number from your console"

MONGODBURI = "Add your Mongodb Connection string here"

Save your data env file and run the following commands in your terminal

$ cd server

$ npm install

$ npm run serve

🔁 We can start making changes now! 🥳

  1. Create a new branch for the issue you are working on

    $ git checkout -b <branch-name>

  2. Make your changes. Then, stage and commit them using:

    $ git add .

    $ git commit -m "This is a commit message"

  3. Push your changes to your forked repository.

    $ git push origin <branch-name>

✨ Finally Lets Create a Pull Request 🔃

  1. Create a PR with listing all your contributions and wait for it to get merged