GithubHelp home page GithubHelp logo

github-template-javascript's Introduction

Akkadu Github Template Javascript

Netlify Status Contributors Forks Stargazers Issues Language grade: JavaScript FOSSA Status Version Maintenance David Dependencies Status styled with prettier LinkedIn

Get started on Javascript projects at Akkadu much quicker by using this template repository.

Explore the docs »

View DemoReport BugRequest Feature

Table of Contents

About The Project

Product Name Screen Shot

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.

Built With

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.

Getting Started

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.

Prerequisites

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

Installation

  1. Clone the repo
  2. Get the .env keys from [email protected]
git clone https://github.com/Akkadu/github-template-javascript.git
  1. Install NPM packages
yarn install

Usage

Use 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.md

Roadmap

See the open issues for a list of proposed features (and known issues)

Contributing

Want to make a change? Any contributions you make are greatly appreciated.

  1. Clone the repo
  2. Create your Feature Branch (gco -b release/my-project)
  3. Commit your Changes (git commit -m 'add: small addition')
  4. Push to the Branch (git push origin release/my-project)
  5. Open a Pull Request

Author

👤 JT Houk [email protected]

Dependencies

FOSSA Status

Acknowledgements

github-template-javascript's People

Contributors

houkasaurusrex avatar dependabot[bot] avatar

Stargazers

Rouiller Romain avatar  avatar

Watchers

James Cloos avatar

Forkers

fossabot

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.