Read Me Template

An awesome README template to jumpstart your projects!
Online website »

View Demo · Report Bug · Request Feature

---

🧐 About The Project

![Product Name Screen Shot][product-screenshot]

There are many great README templates available on GitHub, however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.

Here's why:

• 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 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

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.

• Vue - Approachable. Builds on top of standard HTML, CSS and JavaScript with intuitive API and world-class documentation.
• Symfony - Symfony is a set of reusable PHP components and a PHP framework to build web applications, APIs, microservices and web services.

🏁 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.

• npm

npm install npm@latest -g

🏗️ Installation

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

git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

npm install

4. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

🚀 Deployment

1. Build Build project for production. Will generate /public folder

$ npm generate

2. Preview (optional)

$ npm preview

Checkout the deployment documentation for more information.

🎈 How to use

1. Create entity

$ php bin/console make:entity

2. Create database migration

$ php bin/console make:migration

3. Execute migration

$ php bin/console doctrine:migrations:migrate

🗂️ Folder organisation

.
├─ assets
├─ sass
│   ├─ components
│   ├─ layout
│   ├─ pages
│   ├─ reset
│   ├─ utilities
│   └─ main.scss
└─ index.html

🚧 Roadmap

• Add Changelog
• Add back to top links
• Add Additional Templates w/ Examples
• Add "components" document to easily copy & paste sections of the readme
• Multi-language Support
  • Chinese
  • Spanish

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

📝 License

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

✍️ Authors

Alban Pierson – pro.pierson.alban@gmail.com - https://github.com/Zalbani/

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References