Get started on Javascript projects at Akkadu much quicker by using this template repository.
View Demo • Report Bug • Request Feature
This is a project designed to reduce new project overhead, decrease cost of project maintenance, and enforce standardization of project management tools (e.g. linters, READMEs, Issue templates, etc.).
Here's why:
Spending time writing a good README shouldn't be a pain for every new project on our platform. If you add PR templates, Issue templates, lint configs, .gitignore files, etc., the task of creating new repositories eventually becomes hours of finding things to copy/paste.
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating a README from scratch
- You should element DRY principles to the rest of your life 😄
This is by no means a one-size-fits-all solution, but it should get you started much quicker than trying to pull together the latest best practices from who knows where only to find out the standards are changing.
A list of commonly used resources that I find helpful are listed in the acknowledgements.
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- yarn
npm install yarn@latest -g- Clone the repo
- Get the .env keys from techforce@akkadu-team.com
git clone https://github.com/Akkadu/github-template-javascript.git- Install NPM packages
yarn installUse this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Update your project's .github templates
rm -rf .github
mkdir -p .github
echo 'Downloading latest "contributing.md"...'
curl https://raw.githubusercontent.com/Akkadu/github-template-javascript/master/.github/contributing.md -o .github/contributing.md
echo 'Downloading latest "pull_request_template.md"...'
curl https://raw.githubusercontent.com/Akkadu/github-template-javascript/master/.github/pull_request_template.md -o .github/pull_request_template.md
mkdir -p .github/ISSUE_TEMPLATE
echo 'Downloading latest "bug_report.md"...'
curl https://raw.githubusercontent.com/Akkadu/github-template-javascript/master/.github/ISSUE_TEMPLATE/bug_report.md -o .github/ISSUE_TEMPLATE/bug_report.md
echo 'Downloading latest "feature_request.md"...'
curl https://raw.githubusercontent.com/Akkadu/github-template-javascript/master/.github/ISSUE_TEMPLATE/feature_request.md -o .github/ISSUE_TEMPLATE/feature_request.md
echo 'Success!'Download the template README.md
curl https://raw.githubusercontent.com/Akkadu/github-template-javascript/master/README.md -o README.mdSee the open issues for a list of proposed features (and known issues)
Want to make a change? Any contributions you make are greatly appreciated.
- Clone the repo
- Create your Feature Branch (
gco -b release/my-project) - Commit your Changes (
git commit -m 'add: small addition') - Push to the Branch (
git push origin release/my-project) - Open a Pull Request
👤 JT Houk jt1992@gmail.com
- Website: jt.houk.space
- Twitter: @HoukasaurusRex
- Github: @HoukasaurusRex
- LinkedIn: @JT Houk
