Learning to code should also be fun. That's why we built Zappycode! A community of learners that don't like doing things the boring way. Join and see what it's all about.
Feel free to submit issues and enhancement requests under the issues tab.
Zappycode welcomes contributions from the community and is an open source project. When contributing please be kind and respectful. In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on Github, top right-hand corner.
- Clone the project to your own machine.
git clone https://github.com/<yourusername>/zappycode-django.git - Commit changes to your own branch
Create a new branch:
git checkout -b new_branchCreate a new remote for the upstream repo:git remote add upstream https://github.com/<your username>/zappycode-django - Push your work back up to your fork
git push -u origin new_branch - Submit a Pull Request so that we can review your changes.
-
Fork the repo on Github, top right-hand corner. This creates a new copy of my demo repo under your GitHub user account with a URL like: https://github.com//zappycode-django
-
Clone the project to your own machine.
git clone https://github.com/<YourUserName>/zappycode-django -
Commit changes to your own branch Create a new branch:
git checkout -b new_branch(name it whatever you like. Here, it is new_branch) Create a new remote for the upstream repo:git remote add upstream https://github.com/<your username>/zappycode-django -
Make a Virtual Environment using-
conda create --name zappycodeenv python=3.6.9If virtual environment isn't activated automatically, enter:conda activate zappycodeenv -
Install Requirements:- The Pipfile and Pipfile.lock contain dependencies. Read pipfiles to know how to use them to install dependecies. If that doesn't work, do as directed below:
-
If you don't have pipenv, install it using
pip install pipenv -
Enter:
pipenv lock -r(You need to be present in the zappycode directory!) -
When it says "Successfully created virtual environment!" copy and paste Everything below virtualenv location in a text file and save it in the zappycode project cloned folder by the name of requirements.txt.
-
Enter:
pip install -r requirements.txtin shell.
-
-
Now you can make changes to the code.
-
Push it!
git push -u origin new_branch -
Once you push the changes to your repo, the compare & pull request button will appear in GitHub. Click it!
-
Add some info about the changes you made and click 'Create pull request' button.
-
Done!
Make sure Python v3.6.9 is installed on your machine. Already have a version installed? See here for help.
- Follow 📃Steps 1 - 3 under contributing.
- Setup 💻Virtual Environment inside the zappycode working directory.
- run
pipenv installin your terminal to setup the venv. - then
pipenv shellto activate the venv. - to deactivate the venv run
exit
- Start Contributing! 😃
- 🚀Push your work back up to your fork
git push -u origin new_branch
- Click the create pull request link in terminal.
- Add some info about your changes
- Submit pull request
- 🎉Done! You're Awesome⭐