This is the repository for the stage 2 promotion task for HNG i7. Each team member is expected to create a file in the scripts folder with any programming language of their choice (preferrably JavaScript, PHP and Python).
For quick navigation:
- Getting Started
- Creating Your Script
- Styleguides
- Running a Local Test Server
- Debugging PHP
- Testing Your Script
- Making a Pull Request
To get started locally, follow these instructions:
- Unless you've already done so, you will first need to make a fork of this repo.
- Use your forked repo to clone to your local repository by using
git
. - Make sure that you have XAMPP 7.x.x or later installed (remember your install path for later). See instructions here.
The stage 2 task requres each and every member in Team Fury to create a script. Read further for more information.
The goal of the stage 2 task is to create a script file that outputs a string in the following format:
Hello World, this is <Your Full Name> with HNGi7 ID <Your HNG ID> and email <Your Email> using <Your Programming Language> for stage 2 task
.
- Your script file should be located in the scripts folder.
scripts(folder) associated script files...
- Your script file should be named using this convention:
<your-username>.(js or php or py)
. - The 4 required data fields should be variables.
- Your programming language should either be: PHP, Python, or JavaScript.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Run to output..." not "Runs to output...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include [ci skip] in the commit title
-
After forking and cloning the repository
-
Create a new file in the scripts folder(strictly the scripts folder) with your Slack username
-
All JavaScript must adhere to JavaScript Standard Style
-
save the updated file and test it
NOTE: Your Change should not break the existing code
-
After forking and cloning the repository
-
Create a new file in the scripts folder(strictly the scripts folder) with your Slack username
-
All Python must adhere to Python Standard Style
-
save the updated file and test it
NOTE: Your Change should not break the existing code
-
After forking and cloning the repository
-
Create a new file in the scripts folder(strictly the scripts folder) with your Slack username
-
All PHP must adhere to PHP Standard Style
-
save the updated file and test it
NOTE: Your Change should not break the existing code
To run the local test server, follow these instructions:
- Move your local repo to your XAMPP htdocs folder
path/to/your/xampp/htdocs
. - Open the XAMPP Control Panel.
- Start the Apache module.
- In the URL bar of your preferred browser, go to
localhost/<local-repo-folder-name>/index.php
. The<local-repo-folder-name>
is the folder name of the local repo you moved in step 1 above.
To run a debugger on your PHP code, follow these instructions:
- See instructions here.
- See instructions here.
For other IDEs, you can google how to setup debugging in your IDE.
Or you can create a PR adding instructions, on this README file, for your IDE.
To test your script, follow these instructions:
- Run a local test server
- Check the outcome of your script through the website's UI.
If your code passed on during testing, you will have to make a PR to the main repository's dev branch.
Follow these instructions:
- On your local repo, commit your script to your remote repo.
- On your remote repo, make a PR to the main repository's dev branch.
Happy Hacking