unfoldingword/blank-project-template

Blank project template

project_title

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Purpose

• The purpose of this project

Problem

• The problem statement

Scope

• What's in scope and out of scope for this project?

Background

• What led us to this point? How did we get here?

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email, email_client, project_title, project_description

(back to top)

Built With

• Next.js
• React.js
• Vue.js
• Angular
• Svelte
• Laravel
• Bootstrap
• JQuery

(back to top)

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

Data what is the source of the data and data formats are covered by this project?

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation/First Steps

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/github_username/repo_name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage/Integration

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.

For more examples, please refer to the Documentation Possibly JS Docs.

Styleguidist link

(back to top)

Roadmap

• [] Feature 1
• [] Feature 2
• [] Feature 3
  • [] Nested Feature

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)

blank-project-template's Issues

Badge URLs are not encoded in Markdown Correctly.

Currently:

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

Should be:

[![Contributors][contributors-shield]](contributors-url)
[![Forks][forks-shield]](forks-url)
[![Stargazers][stars-shield]](stars-url)
[![Issues][issues-shield]](issues-url)
[![MIT License][license-shield]](license-url)
[![LinkedIn][linkedin-shield]](linkedin-url)

The repo does not use the template

This repo, itself, should use the template. And put the template itself as another file.

So for example,

• copy README.md to README-template.md
• update README.md to be an actual use of the template (which would be very instructive to the curious)

Badges Question

While attempting to implement the README in another project I was unsure how to get the badges to function.

See: https://github.com/unfoldingWord/proskomma-react-hooks

It just displays unrendered Markdown in place of the badges.

Can we update the documentation to guide the user in how to make them work?

Screenshot Question

While attempting to implement the README in another project I was unsure how to get the screenshot to function.

See: https://github.com/unfoldingWord/proskomma-react-hooks

It just displays unrendered Markdown in place of the screenshot.

Can we update the documentation to guide the user in how to make them work?