Laravel 254 Share Book

This book is a collection of code snippets, projects and articles written and done by the Laravel community based in Kenya. Discussions on the book are stored using Lara254 Disqus.

Book Format

The book will mainly hold pages with content that displays functional code use that is applicable in the Laravel. Readers will have the ability to comment on pages and get the writers feedback. Discussions on individual pages will help in further understanding the code available in the page. Also will help writers get useful feedback that can help improve the code further.

Another important feature other than code snippets, members of the community will be able to share links to open source projects they are doing. With a simple share, having the link to the repository and include the README file for the project. The community is able to learn from each other and offer support (e.g code contributions) to such projects. Apart from sharing open source projects users can also share website links to projects they have worked on. (Ensure you have the copy rights to say you have worked on it). This helps new members of the community see the end products of Laravel projects and be able to interact with them.

The book also gives writers the ability to write articles with various technical related topics. You are advised that articles should be technically oriented and have a touch of Laravel for easy acceptance as material worth to be in the book.

Please note the format of the book will change as it grows or by popular demand from the community.

Contribute to this book

You can contribute to this book by providing material(s) that you are the author of, and you would like to share with the community. The materials may include articles on coding, code snippets, opensource project github (and the likes) repositories or links to projects you have worked on.

Create a page

The share book is built on top of gitbook.

  1. Familiarise yourself with markdown and gitbook documentation.
  2. Git clone the share-book repository.
  3. Install gitbook and serve ensuring the pages render correctly. 
        `npm install
     npm run docs:prepare
     npm run docs:watch`
  4. In your local repository create your page under the correct content folder.
  5. Create a link to your page in the table of contents. Please add your page in alphabetical order. Only the project maintainers are allowed to change the page ordering.
  6. Test your page can be viewed by running npm run docs:watch
  7. Git commit with appropriate message and push.
  8. Create a pull request to the main project. Pull request will be discussed and reviewed before acceptance.
  9. Once accepted go to the online community version to check your page for comments.
  10. Congratulations and Thank you for your contributions.

All materials are welcomed and the community is encouraged to submit as much content as possible to build an awesome read.

Readers are advised to use moderate language when making comments, advocate for positive criticism and provide improvements where possible.

Suggestions to improvements of book and available features/format are welcomed. If you think of something that the book is missing or would like added just open an issue on Github detailing issue/feature and available project maintainer will pick it up.

Help and Support

Any help relating with the assistance of code written in a given page should be asked using the comments section. Each page will be signed by its author and if they so wish can provide a way to get in touch for further queries that can not be covered by the scope of page discussions.

Further assistance will be offered on Github. Just open an issue and one of the maintainers of the project will reply as soon as possible.